Skip to main content
PATCH
Update a version's lifecycle governance status / expiry

Authorizations

x-api-key
string
header
required

Path Parameters

doc_id
string<uuid>
required
version_id
string<uuid>
required

Body

application/json

PATCH body. extra='forbid' rejects unknown keys; field presence is read via model_fields_set so an explicit expires_at: null (clear) is distinguishable from an omitted expires_at (leave unchanged).

governance_status
enum<string> | null
Available options:
active,
retired,
suppressed,
manual_hold,
expired
expires_at
string<date-time> | null
reason_code
string | null
Maximum string length: 64
note
string | null
Maximum string length: 2000
idempotency_key
string | null
Maximum string length: 128

Response

Successful Response

Governance view of a version + the computed effective serving status.

id
string<uuid>
required
document_id
string<uuid>
required
knowledge_base_id
string<uuid>
required
version_number
integer
required
state
string
required
scan_status
string
required
governance_status
string
required
effective_serving_status
string
required
expires_at
string<date-time> | null
governance_reason_code
string | null
governance_note
string | null
governance_updated_by
string<uuid> | null
governance_updated_at
string<date-time> | null
governance_policy_version
string | null