Modify a purge routine

put

https://{hostname}/storage/v1/cpcodes/{cpcodeId}/age-deletions

Make changes to an automatic purge routine for a specific CP code.

Path Params

cpcodeId

integer

required

Uniquely identifies a Content Provider.

Query Params

ageDeletionDirectoryPrefix

string

This identifies a subdirectory to target for purging.

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Automatic purge routines perform a routine scan of a target directory, and once a specified capacity is reached, the system will begin to purge files that are older than a date you specify.

ageDeletionDays

integer

When the ageDeletionSizeBytes value is reached for the target directory, this number is subtracted from the current date to determine a timestamp. Files older than this timestamp are purged.

ageDeletionDirectory

string

The target directory for an Automatic Purge Routine.

ageDeletionExclusionRegex

string

POSIX regular expression pattern matching the filenames to exclude from the purge.

ageDeletionRecursivePurge

boolean

Defaults to false

Whether subdirectories within the target directory are also included in the purge. If false, only files within the target directory are purged.

ageDeletionSelectionRegex

string

POSIX regular expression pattern matching the filenames to include in the purge.

ageDeletionSizeBytes

integer

Automatic purge occurs when the target directory reaches this size, in bytes.

Response

200

Successful Response.

Language

URL

Loading…