Sign in
Policies

Update Policy Version Status

Update a policy version's status. Valid transitions:

  • draft -> published
  • published -> production (demotes current production to published)
  • production -> published (demotes, policy becomes inactive)
put/policies/{policy_id}/status

Path parameters

policy_idstring required

Request body

version_statusstring required

New status: 'published' or 'production'.

Response

Successful Response

policy_idstring required

Unique ID of the policy.

policy_namestring required

Name of the policy.

version_numberinteger

Version number of this policy.

version_statusstring

One of: draft, published, production.

parent_version_idstring nullable

Policy ID this version was cloned from.

is_latestboolean

True if this is the latest version by version_number.

published_atstring date-time nullable

When this version was published.

production_atstring date-time nullable

When this version was promoted to production.

inheritstring nullable

Parent policy name.

descriptionstring nullable

Policy description.

guardrails_addstring[]

Guardrails to add.

guardrails_removestring[]

Guardrails to remove.

conditionobject nullable

Policy condition.

pipelineobject nullable

Optional guardrail pipeline.

created_atstring date-time nullable

When the policy was created.

updated_atstring date-time nullable

When the policy was last updated.

created_bystring nullable

Who created the policy.

updated_bystring nullable

Who last updated the policy.

Changes

Changed in 5 of the 15 revisions of this API.10