Archive Policy Rule

DELETE /policies/policy-rules/{policyRuleId}

Archives a PolicyRule its id. Archived policy rules will no longer be enforced.

Required Permissions

NameConditions

PolicyRules:Archive

Always Required

Parameters

Path parameters

Path parameterDescription

policyRuleId

Unique identifier of the policy rule like: pr-orange-magnesium-a0606d08b2

Response

Response example

Note the status is now set to Archived:

{
   "id": "pr-tennessee-artist-f2078ea085",
   "version": "f1b1me4kd",
   "kind": "TransferAmountLimit",
   "orgId": "cu-purple-pip-1b417b958500",
   "author": "oe-nine-artist-9de60fef6963",
   "description": "Test Rule 1 PaymentAmountLimit",
   "name": "Test Rule 1",
   "configuration": {
       "kind": "TransferAmountLimit",
       "limit": "10",
       "currency": "USD"
   },
   "tags": [],
   "dateCreated": "2022-07-14T21:22:54.829Z",
   "status": "Archived"
}

Last updated