v22

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-01140308542.4 KB

PolicySetDrafts

Create or resume a policy set draft

Safe draft creation that never overwrites an existing draft. If a draft already exists for this policy set, it is returned as-is (200 OK). Three body modes control how a new draft is initialized: (1) empty body — hydrate from the latest non-archived version, (2) { base_version_id } — hydrate from a specific version, (3) full body with manifest and schema_version — create with explicit content. base_version_id and manifest are mutually exclusive; providing both is rejected.

post/zones/{zone_id}/policy-sets/{policy_set_id}/draft

Path parameters

zone_idstring required

The zone identifier

policy_set_idstring required

The policy set identifier

Headers

X-API-Versionstring

API version header (date-based, e.g. 2026-02-01)

X-Client-Request-IDstring uuid

Unique request identifier specified by the originating caller and passed along by proxies.

Request body

base_version_idstring

ID of a policy set version to hydrate from. Mutually exclusive with manifest — the server rejects requests containing both fields.

schema_versionstring

namestring

descriptionstring

Response

Existing draft resumed (unchanged)

policy_set_idstring required

schema_versionstring required

namestring nullable

descriptionstring nullable

base_version_idstring nullable

ID of the policy set version this draft was hydrated from. Null when the draft was created without an existing version.

created_atstring date-time required

updated_atstring date-time required

updated_bystring required