Sign in
policy_engine

Update Policy

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}

Path parameters

policy_idstring required

Request body

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).

inheritstring nullable

Name of parent policy to inherit from.

pipelineobject nullable

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

policy_namestring nullable

New name for the policy.

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

Changed in 14 of the 42 revisions of this API.31

  • b694deb1e4592See the full diff
    • ○

      api tag policy_engine added

      api-tag-added

    • ○

      api tag Policies removed

      api-tag-removed

  • cfac079bcc042See the full diff
    • ○

      api tag Policies added

      api-tag-added

    • ○

      api tag policy_engine removed

      api-tag-removed

  • a4fccd4bf54d2See the full diff
    • ○

      api tag policy_engine added

      api-tag-added

    • ○

      api tag Policies removed

      api-tag-removed

  • 6246f8d427b72See the full diff
    • ○

      api tag Policies added

      api-tag-added

    • ○

      api tag policy_engine removed

      api-tag-removed

  • c357baf422ab2See the full diff
    • ○

      api tag policy_engine added

      api-tag-added

    • ○

      api tag Policies removed

      api-tag-removed

  • 082b5fabd9095See the full diff
    • ○

      api tag Policies added

      api-tag-added

    • ○

      api tag policy_engine removed

      api-tag-removed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e2f308355e2d2See the full diff
    • ○

      api tag policy_engine added

      api-tag-added

    • ○

      api tag Policies removed

      api-tag-removed

  • 89805a9f84ad2See the full diff
    • ○

      api tag Policies added

      api-tag-added

    • ○

      api tag policy_engine removed

      api-tag-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5c00a227eebf2See the full diff
    • ○

      api tag policy_engine added

      api-tag-added

    • ○

      api tag Policies removed

      api-tag-removed

    This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 404bba17aabe2See the full diff
    • ○

      api tag Policies added

      api-tag-added

    • ○

      api tag policy_engine removed

      api-tag-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog