Policies

Update Policy

Changed on

Update an existing policy.

Example Request:

curl -X PUT "http://localhost:4000/policies/123e4567-e89b-12d3-a456-426614174000" \
    -H "Authorization: Bearer <your_api_key>" \
    -H "Content-Type: application/json" \
    -d '{
        "description": "Updated description",
        "guardrails_add": ["pii_masking", "toxicity_filter"]
    }'
put/policies/{policy_id}

Request

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

Path parameters

policy_idstring required

Request body

policy_namestring nullable

New name for the policy.

inheritstring nullable

Name of parent policy to inherit from.

descriptionstring nullable

Human-readable description of the policy.

guardrails_addstring[] nullable

List of guardrail names to add.

guardrails_removestring[] nullable

List of guardrail names to remove (from inherited).

pipelineobject nullable

Optional guardrail pipeline for ordered execution. Contains 'mode' and 'steps'.

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.

definition_location'db' | 'config'

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

Changes