Policy Application Programming Interface

Find Policy API contracts, an ordered lifecycle example, and authorized recovery references.

Use the Policy application programming interface (API) to author and govern policies. Track delivery separately from approval and target protection. Approval establishes a governed revision: the approved version of policy intent. A draft snapshot records saved proposal content, not another approved revision. Compilation produces target output. Publication and target activation happen separately. Begin with authentication and shared contracts.

Choose Your Path

Choose the API reference that matches your task:

Operation Families

Choose the reference for the operation you need:

The API base normally uses /pty/policy/v1.0, independently of the application version. Your deployed /swagger page and /doc document expose its schema. Use the endpoint-specific runtime rules here when conditional-header descriptions differ. An entity tag (ETag) is a server-issued resource validator. Draft commands use Draft-ETag. Archive uses the policy ETag. Copy the required token unchanged into If-Match to pin the command to inspected state. Do not substitute the governed policy validator for a current draft token.


Authentication and Shared Request Contracts

Authenticate callers and distinguish command authority, policy grants, draft validators, and ownership preconditions.

Policy API Operation Directory

Find canonical operation families and retain links to earlier endpoint references.

Save, Review, Approve, and Inspect Delivery

Follow a separate-user API handoff using current draft validators and independent delivery evidence.

Application Programming Interface Errors and Safe Recovery

Interpret Policy API failures without confusing stale drafts, unavailable evidence, and retryable delivery work.

Service and Schema Publication Operations

Reference the request, response, and failure contracts for this operation family.

Catalog, Compilation, and Preview Operations

Reference the request, response, and failure contracts for this operation family.

Policy Queries and Draft Operations

Reference policy reads, server-validated draft creation, saved snapshots, rollback, and cancellation.

Submission, Review, Approval, and Archive Operations

Reference lifecycle decisions, exact draft preconditions, authenticated actors, and asynchronous delivery boundaries.

History and Policy Access Operations

Reference policy grants, legacy versions, bounded lifecycle history, and restricted audit exports.

Product Retrieval and Compatibility Deployment

Reference consumer output retrieval and distinguish compatibility deployment from governed publication.

Authoring Schema Operations

Reference the request, response, and failure contracts for this operation family.

Recovery and Ownership Reconciliation

Reference nine operations for restricted diagnostics, retained delivery recovery, archive evidence, and native ownership reconciliation.

Last modified : November 03, 2026