Sign in
OpenAPI 3.1.02026-08-226994571.1 MB

1e929292ddd5

Policies

Get Policy

Get a policy by ID.

Example Request:

curl -X GET "http://localhost:4000/policies/123e4567-e89b-12d3-a456-426614174000" \
    -H "Authorization: Bearer <your_api_key>"
get/policies/{policy_id}

Path parameters

policy_idstring required

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.