latestOpenAPI 3.1.02026-08-236994571.1 MB

79928a3d37d3

Policies

List Policies

List all policies from the database. Optionally filter by version_status.

Query params:

  • version_status: Optional. One of "draft", "published", "production". If omitted, all versions are returned.

Example Request:

curl -X GET "http://localhost:4000/policies/list" \
    -H "Authorization: Bearer <your_api_key>"
curl -X GET "http://localhost:4000/policies/list?version_status=production" \
    -H "Authorization: Bearer <your_api_key>"

Example Response:

{
    "policies": [
        {
            "policy_id": "123e4567-e89b-12d3-a456-426614174000",
            "policy_name": "global-baseline",
            "version_number": 1,
            "version_status": "production",
            "inherit": null,
            "description": "Base guardrails for all requests",
            "guardrails_add": ["pii_masking"],
            "guardrails_remove": [],
            "condition": null,
            "created_at": "2024-01-01T00:00:00Z",
            "updated_at": "2024-01-01T00:00:00Z"
        }
    ],
    "total_count": 1
}
get/policies/list

Query parameters

version_statusstring nullable

Response

Successful Response

total_countinteger

Total number of policies.