Skip to main content
Skip table of contents

Update multiple purge configurations

Request

To change the retention period for multiple purge configurations, send a PUT request to:

http://<server>:<port>/cpm/operator/purgeConfigurations

Headers

  • role – must be operator

Mandatory arguments

In each purge configuration block, you must specify:

  • id – the ID of the purge configuration to be updated (in body)
  • retentionPeriod – the new retention period in days (in body)
You only need to include configuration blocks for the purge configurations that you want to change the retention period for.

Other arguments

None

Example

A PUT request with this payload will update the retention periods for the specified purge configurations:

CODE
{

   "purgeConfigurationSet":[
      {
         "id":"pc01",
         "retentionPeriod":15
      },
      {
         "id":"pc02",
         "retentionPeriod":15
      },
      {
         "id":"pc01",
         "retentionPeriod":15
      }
   ]
}

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

A forbidden request returns an HTTP 403 status.

Example

CODE
{
   "totalRecords":3,
   "selfSet":[
      "/purge/v1/configurations/pc01",
      "/purge/v1/configurations/pc02",
      "/purge/v1/configurations/pc03"
   ]
}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.