Activate a Policy version

POST /v1/policies/{policy_id}/versions/{version}/activate

Makes the version the active one and answers it. An agent-scoped change reaches Calls only through the next Agent version publish, which pins it; an organization-scoped one reaches the next Call. A Call never changes Policy versions mid-Call. It emits the Webhook event policy.version.activated. A write to an organization-scoped Policy, or one that disables a compliance-tagged Policy, also needs policies:admin and is otherwise refused with forbidden and the detail policies_admin_required.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the policies:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/policies/pol_.../versions/1/activate" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

const response = await fetch(`${process.env.VOCAL_API}/v1/policies/pol_.../versions/1/activate`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
  },
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/policies/pol_.../versions/1/activate",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is PolicyVersion.