Get Single Package Cleanup Policy by Key API

Description: This API is called to provide details on a single package cleanup policy.

Security: Requires a platform admin. A project admin with permission can call this API on the project level.

Produces: application/json

Usage: GET http://{host:port}/artifactory/api/cleanup/packages/policies/{policyKey}

Query Parameters:

Field	Type	Description
`policyKey`	string	The ID that identifies the policy. This ID was configured when creating the policy. You can find the policy ID by calling Get all Cleanup Policies API, searching the results for the appropriate description and then its corresponding ID.

Sample Query

GET http://{host:port}/artifactory/api/cleanup/packages/policies/key1

Sample Response:

{
   "key": "key1",
   "description": "some test description",
   "cronExp": "0 15 10 * * ? 2024",
   "durationInMinutes": 150,
   "enabled": false,
   "skipTrashcan": false,
   "searchCriteria": {
       "packageTypes": [
           "docker",
           "maven"
       ],
       "repos": [
           "repo1",
           "repo2"
       ],
       "excludedRepos": [],
       "includedPackages": [
               "com/jfrog",
       ],
       "excludedPackages": [
               "com/jfrog/latest",
       ],
       "includeAllProjects": false,
       "includedProjects": [
               "project1",
               "project2"
       ],
       "createdBeforeInMonths": 12,
       "lastDownloadedBeforeInMonths": 1
       "keepLastNVersions": 0
   }
}

The response include the following information:

Property	Description
`key`	The ID that identifies the policy. This ID that was configured for the policy when it was created.
`description`	Description that was defined for the policy.
`cronExp`	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`	The maximum duration (in minutes) for policy execution, after which the policy will stop running even if not completed.
`enabled`	A true value means the policy can be executed. A false value means that it cannot.
`skipTrashcan`	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`	The criteria that define aspects of the policy such as package types (docker, maven), repository names in which the policy will be run, and other relevant criteria. For more details see the table below.

Search Criteria

Field	Type	Description
`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. Note This parameter is relevant only on the global level, for Platform Admins.
`includedProjects`	string	Enter the project names on which you want the policy to run. Note This parameter is relevant only on the global level, for Platform Admins.
`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. Note A policy must use one of the three settings: `createdBeforeInMonths`, `lastDownloadedBeforeInMonths`, or `keepLastNVersions`. `createdBeforeInMonths`, and `lastDownloadedBeforeInMonths` can be used together, but they cannot be used with `keepLastNVersions`. Meaning, use either `createdBeforeInMonths` and `lastDownloadedBeforeInMonths` (or just one of them), or use `keepLastNVersions`.
`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. Note JFrog recommends using `lastDownloadedBeforeInMonths` to ensure that packages currently in use are not deleted.
`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. Note Versions are determined by creation date. Not all package types support this condition. For information on which package types support this condition, click here.Package Types Coverage

Response Error Codes

Code	Description
400	Validation errors.
500	Internal server error.

Note

Note

Note

Note

Note