Create a Package Cleanup Policy

post

https://{jfrog_url}/artifactory/api/cleanup/packages/policies/{policyKey}

This API is called to create a new package-level cleanup policy. Packages Cleanup Policies APIs are supported on Artifactory version 7.98.2 and later.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

policyKey

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.

Body Params

key

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.

description

string

length ≤ 256

A description of the policy.

cronExp

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.

projectKey

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.

itemType

string

The type of item (package).

durationInMinutes

integer

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

enabled

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.

skipTrashcan

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

201Created

400Bad Request

401Unauthorized

403Forbidden

409Conflict

500Internal Server Error