Skip to main content
POST
Activate policy

Authorizations

X-API-Key
string
header
required

Headers

API-Version
enum<string>
default:v1

API version (defaults to the latest supported version if omitted).

Available options:
v1
Idempotency-Key
string

Unique key (1-255 printable ASCII chars) used to safely retry write operations. Same key + body returns the cached response; same key + different body returns 409.

Required string length: 1 - 255

Path Parameters

id
string<uuid>
required

Policy ID

Body

application/json
comment
string

Optional comment recorded against the approval request for audit purposes.

Maximum string length: 500
Example:

"Activating after security review"

Response

Success

approval_request_id
string

Identifier of the approval request, for correlation in the dashboard and webhook events. Not a pollable public endpoint.

Example:

"9b2e7a1c-3d4f-4a8b-9c0d-1e2f3a4b5c6d"

expires_at
string

ISO-8601 time at which the approval request expires; if it lapses the policy stays draft.

Example:

"2026-05-17T10:30:00Z"

message
string

Human-readable explanation of the next steps.

policy_id
string

The policy awaiting activation. Poll GET /v1/policies/{policy_id} until status=enforced.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

required_approvals
integer

Number of approvals required before the policy becomes enforced.

Example:

2

status
string

Always "pending_authorization" for this response.

Example:

"pending_authorization"