Create a Package Cleanup Policy API

key

string

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.

This parameter is mandatory.

description

string

A description of the policy. This parameter is optional.

cronExp

integer

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.

durationInMinutes

integer

The maximum duration (in minutes) for policy execution, after which the policy will stop running even if not completed. While setting a maximum run duration for a policy is useful for adhering to a strict cleanup schedule, it can cause the policy to stop before completion.

enabled

string

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

string

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.

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.

searchCriteria

See below

The criteria that define aspects of the policy such as package types (docker, maven), names of repositories in which the policy will run, and other relevant criteria. For more details see the table below.

packageTypes

string

The package types that are cleaned up by the policy. For a list of the permitted package types, click here.Package Types Coverage

You must enter at least one package type.

repos

string

Specify one or more patterns for the repository name(s) on which you want the cleanup policy to run. You can also specify explicit repository names. Specifying at least one pattern or explicit name is mandatory. Only packages in repositories that match the pattern or explicit name will be deleted.

excludedRepos

string

Specify patterns for repository names or explicit repository names that you want excluded from the cleanup policy. This parameter is optional.

includedPackages

string

Specify a pattern for a package name or an explicit package name on which you want the cleanup policy to run. Only one pattern or explicit name can be entered. To include all packages, use "**". For example: "includedPackages": ["**"]

This parameter is mandatory.

excludedPackages

string

Specify explicit package names that you want excluded from the policy. Only explicit names (and not patterns) are accepted. This parameter is optional.

includeAllProjects

boolean

Set this value to true if you want the policy to run on all Artifactory projects. The default value is false. This parameter is optional.

includedProjects

string

Enter the project keys for the projects on which you want the policy to run. To include repositories that are not assigned to any project, enter the project key default.

createdBeforeInMonths

integer

The cleanup policy will delete packages based on how long ago they were created. For example, if this parameter is 2 then packages created more than 2 months ago will be deleted as part of the policy.

lastDownloadedBeforeInMonths

integer

The cleanup policy will delete packages based on how long ago they were dowloaded. For example, if this parameter is 5 then packages downloaded more than 5 months ago will be deleted as part of the policy.

keepLastNVersions

integer

Set a value for the number of latest versions to keep. The cleanup policy will remove all versions prior to the number you select here. The latest version is always excluded.