Policy API Operation Directory
The Policy application programming interface (API) uses the stable
/pty/policy/v1.0 base path, independently of the application build version.
Configure POLICY_API for your gateway through the
authentication reference.
Paths identify policies independently of their draft cycles and saved snapshots. Check each operation’s required capability, resource grant, and validator before calling it. A successful lifecycle command can accept asynchronous work without completing target delivery.
Choose an Operation Family
Choose the API reference that matches the operation you need:
- Catalog and authoring covers input discovery, compilation, and preview.
- Queries and drafts covers policy reads and draft changes.
- Governance covers submission, review, approval, and archive.
- History and access covers lineage, audit export, and grants.
- Delivery covers consumer retrieval and compatibility deployment.
- Recovery and reconciliation covers diagnostics, retry, and ownership decisions.
- Authoring schemas covers Cedar, actions, and attribute vocabulary.
- Service operations covers health, logs, metrics, and published schemas.
Follow the worked lifecycle for save, submission, separate-user review, approval, and delivery inspection. The entries below retain earlier endpoint anchors.
GET /version
Refer to canonical operation reference.
GET /doc
Refer to canonical operation reference.
GET /log
Refer to canonical operation reference.
POST /log
Refer to canonical operation reference.
GET /health
Refer to canonical operation reference.
GET /ready
Refer to canonical operation reference.
GET /live
Refer to canonical operation reference.
GET /catalog
Refer to canonical operation reference.
POST /catalog/recommend
Refer to canonical operation reference.
GET /catalog/principals
Refer to canonical operation reference.
GET /catalog/resources
Refer to canonical operation reference.
GET /catalog/actions
Refer to canonical operation reference.
POST /policies/compile
Refer to canonical operation reference.
GET /policies
Refer to canonical operation reference.
GET /policies/{policy_id}
Refer to canonical operation reference.
GET /policies/{policy_id}/access-grants
Refer to canonical operation reference.
POST /policies/{policy_id}/access-grants
Refer to canonical operation reference.
DELETE /policies/{policy_id}/access-grants/{grant_id}
Refer to canonical operation reference.
POST /policies
Refer to canonical operation reference.
PUT /policies/{policy_id}
Refer to canonical operation reference.
GET /policies/{policy_id}/validation
Refer to canonical operation reference.
GET /validation-diagnostics/{support_reference}
Refer to canonical operation reference.
DELETE /policies/{policy_id}
Refer to canonical operation reference.
POST /policies/{policy_id}/submit
Refer to canonical operation reference.
POST /policies/{policy_id}/request-changes
Refer to canonical operation reference.
POST /policies/{policy_id}/approve
Refer to canonical operation reference.
POST /policies/{policy_id}/archive
Refer to canonical operation reference.
GET /policies/{policy_id}/versions
Refer to canonical operation reference.
GET /policies/{policy_id}/history
Refer to canonical operation reference.
GET /policies/{policy_id}/audit-export
Refer to canonical operation reference.
GET /policies/{policy_id}/operations
Refer to canonical operation reference.
GET /policies/{policy_id}/pim-reconciliations
Refer to canonical operation reference.
POST /policies/{policy_id}/pim-reconciliations
Refer to canonical operation reference.
GET /pim-reconciliations/bindings
Refer to canonical operation reference.
GET /pim-reconciliations
Refer to canonical operation reference.
POST /pim-reconciliations
Refer to canonical operation reference.
POST /policies/{policy_id}/deployments/{deployment_id}/retry
Refer to canonical operation reference.
POST /policies/{policy_id}/archive-evidence
Refer to canonical operation reference.
GET /product-policies/{product_type}
Refer to canonical operation reference.
POST /product-policies/{product_type}/acknowledgements
This release does not register this route. Do not call it. Refer to product delivery for current consumer contracts.
POST /policies/preview
Refer to canonical operation reference.
POST /policies/{policy_id}/deploy
Refer to canonical operation reference.
POST /policies/{policy_id}/deploy/securequery
This release does not register this route. Do not call it. Refer to product delivery for current consumer contracts.
GET /securequery-profiles
This release does not register this route. Do not call it. Refer to product delivery for current consumer contracts.
POST /securequery-profiles
This release does not register this route. Do not call it. Refer to product delivery for current consumer contracts.
GET /securequery-profiles/{profile_uuid}
This release does not register this route. Do not call it. Refer to product delivery for current consumer contracts.
PUT /securequery-profiles/{profile_uuid}
This release does not register this route. Do not call it. Refer to product delivery for current consumer contracts.
POST /securequery-profiles/{profile_uuid}/status
This release does not register this route. Do not call it. Refer to product delivery for current consumer contracts.
POST /securequery-profiles/{profile_uuid}/validate
This release does not register this route. Do not call it. Refer to product delivery for current consumer contracts.
GET /schema/cedar
Refer to canonical operation reference.
GET /schema/actions
Refer to canonical operation reference.
GET /schema/authoring-actions
Refer to canonical operation reference.
GET /schema/attributes
Refer to canonical operation reference.
- ←Previous: Authentication and Shared Request Contracts
- Next: Save, Review, Approve, and Inspect Delivery→
Feedback
Was this page helpful?