Skip to main content
PATCH
Set a lineage's retention window

Authorizations

Authorization
string
header
required

API key with the vk_ prefix. Create one from the dashboard.

Path Parameters

name
string
required

Lineage name

Body

application/json
retention_days
integer<int32> | null

Days to keep unprotected versions (0..=3650; 0 = zero-data-retention). null or omitted clears the override so the workspace default applies.

Response

The updated window

A lineage's retention window.

object
string
required

Always "model_retention".

model
string
required

Lineage name.

workspace_default_days
integer<int32>
required

The workspace default (workspace_settings.model_retention_days).

effective_days
integer<int32>
required

What the sweeper actually applies to this lineage: the override if set, else the workspace default. 0 = eligible versions are purged by the next nightly sweep.

retention_days
integer<int32> | null

The lineage override in days; null = the workspace default applies.