Set policies to Do Not Archive

When archiving is enabled, policies that meet the archiving criteria will be automatically archived. See Data Archiving for information on how policies are determined to be archivable.

If you have a policy that you don’t want archived, set that policy’s Do Not Archive flag to true. In Cloud API, you can set this flag to true (do not archive) or false (archive when appropriate) by using this command:

POST /policies/{policyId}/set-do-not-archive

In the request body, pass in the doNotArchive property with the desired value. Here’s an example that prevents archiving of the policy by setting the doNotArchive property to true:

Command

POST /policies/pc:310/set-do-not-archive

Request

{
  "data": {
    "attributes": {
        "doNotArchive": true
    }
  }
}

Optionally, you can include a comment in the request body:

{
  "data": {
    "attributes": {
        "doNotArchive": true,
        "comment": "This policy should not be archived"
    }
  }
}

To allow a policy that has been set to Do Not Archive to be archived, call set-do-not-archive with doNotArchive set to false in the request body.

If you set this property to true on a policy that has already been archived, that policy will not automatically be retrieved, it will remain archived until you retrieve it.