Archive Policy

DELETE /v2/policies/{policyId}

Archives a policy.

circle-info

Required Permissions

Name
Conditions

Policies:Archive

Always Required

Path parameters

Path parameter
Description

policyID

Unique identifier of the Policy. ex. plc-1f04s-lqc9q-xxxxxxxxxxxxxxxx

RResponse

200 - no approval required

Same as Create Policy response, except policy status is "Archived"

202 - approval required

In the case when an approval is first required before the policy can actually be modified, a 202 status code is returned, and the object returned is a "Policy change request", which contains an approvalId. You can use the approvalId to fetch the right approval to be fulfilled before this change request actually executes.

Last updated