Update a Package-Level Cleanup Policy

This REST API is called to update configuration settings for an existing package-level cleanup policy. A policy cannot be updated if it is currently running.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID that identifies the policy.

Body Params
string
required

An ID that is used to identify the cleanup policy. A minimum of three characters is required and can include letters, numbers, underscore and hyphen.

string
length ≤ 256

A description of the policy.

string

The cron expression that determines when the policy is run. This parameter is not mandatory, however if left empty the policy will not run automatically and can only be triggered manually.

string

This key is obtained from the Project Settings screen. This parameter is used only for project-level cleanup policies, it is not used for global-level policies.

string

The type of item (package).

integer

The maximum duration (in minutes) for policy execution, after which the policy will stop running even if not completed.

boolean

A cleanup policy must be created inactive. This parameter is optional, but if used it must be set to FALSE. If set to TRUE when calling this API, the API call will fail and an error message is received.

boolean

A true value means that when this policy is executed, packages will be permanently deleted. false means that when the policy is executed packages will be deleted to the Trash Can.

searchCriteria
object
required
Responses

Language
Credentials
:
URL
LoadingLoading…
Response
Choose an example:
application/json