Update a single purge configuration

Request

To change the retention period for a single purge configuration, send a PUT request to:

http://<server>:<port>/cpm/operator/purgeConfigurations/{id}

Headers

• role – must be operator

Mandatory arguments

• id – the ID of the purge configuration to update (in URL)
• retentionPeriod – the new retention period in days (in body)

Other arguments

None

Example

A PUT request with this payload changes the retention period for the specified purge configuration:

{
   "retentionPeriod" : 10
}

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.

If the specified configuration does not exist, the request returns an HTTP 404 status.

Example

{
  "self": "/purge/v1/configurations/f0f39cc8-4" 
}