policy_engine

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

Request

  • Base URL: https://docs.litellm.com.cn (the document declares no server; this is the origin it was published from)
  • URL: https://docs.litellm.com.cn/policies/{policy_id}/status
  • Auth: API key in header x-litellm-api-key

Path parameters

policy_idstring required

Request body

version_statusstring required

New status: 'published' or 'production'.

Response

Successful Response

conditionobject nullable

Policy condition.

created_atstring date-time nullable

When the policy was created.

created_bystring nullable

Who created the policy.

definition_location'db' | 'config'

Where this policy is defined: 'db' (database) or 'config' (config.yaml).

descriptionstring nullable

Policy description.

guardrails_addstring[]

Guardrails to add.

guardrails_removestring[]

Guardrails to remove.

inheritstring nullable

Parent policy name.

is_latestboolean

True if this is the latest version by version_number.

parent_version_idstring nullable

Policy ID this version was cloned from.

pipelineobject nullable

Optional guardrail pipeline.

policy_idstring required

Unique ID of the policy.

policy_namestring required

Name of the policy.

production_atstring date-time nullable

When this version was promoted to production.

published_atstring date-time nullable

When this version was published.

updated_atstring date-time nullable

When the policy was last updated.

updated_bystring nullable

Who last updated the policy.

version_numberinteger

Version number of this policy.

version_statusstring

One of: draft, published, production.

Changes

No recorded changes to this operation across all 1 revision of this API.