Update Build Cleanup Policy API

Description: This REST API is called to update configuration settings for an existing build cleanup policy.

Note

A policy cannot be updated if it is currently running. If you want to update a running policy, you need to either wait for the policy to complete, or manually stop the run by calling Stop a Running Cleanup Policy API.

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

Usage: PUT /artifactory/api/cleanup/builds/policies/{policyKey}

Produces: application/json

Sample Request:

PUT https://[JFrogPlatformURL]/artifactory/api/cleanup/builds/policies/key1
{
  "key": "key1", //required
  "description": "",
  "cronExp": "0 0 2 * * ?",
  "itemType": "build", //required
  "durationInMinutes": 60,
  "enabled": false,
  "deleteArtifacts": true,
  "skipTrashcan": false,
  "searchCriteria": {
    "includeAllProjects": true,
    "includedProjects": [], //required
    "includedBuilds": [ 
      {
        "name": "**",
        "projectKey": ""
      }
    ], //required
    "excludeBuildsWithReleaseBundles": false,
    "createdBeforeInMonths": 24 //required
  }
}

Parameter	Type	Required	Description
`key`	String	Yes	A unique identifier for the cleanup policy (for example, "key1"). This is a required field and must be unique. Note A minimum of three characters is required, including letters, numbers, underscore and hyphen.
`description`	String	No	A brief description of the cleanup policy (optional).
`cronExp`	String	Yes	A cron expression specifying when the cleanup job will run (for example, `0 0 2 * * ?`). Note This parameter is not mandatory, however if left empty the policy will not run automatically and can only be triggered manually.
`itemType`	String	Yes	The type of items to clean up (`build`). This field is required.
`durationInMinutes`	Integer	No	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 (for example, 60).
`enabled`	Boolean	No	Indicates if the cleanup policy is active (`true`) or disabled (`false`). 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. Note After a cleanup policy is created, it can be set to active by calling Enable/Disable Build Cleanup Policy API.
`deleteArtifacts`	Boolean	No	Deletes the artifacts associated with the build (`true` to delete).
`skipTrashcan`	string	No	A `true` value means that when this policy is executed, builds will be permanently deleted. `false` means that when the policy is executed builds will be deleted to the Trash Can. Note The Global Trash Can setting must be enabled if you want deleted items to be transferred to the Trash Can.
`searchCriteria`	Object	Yes	An object containing search criteria for the cleanup job.
`includeAllProjects`	Boolean	Yes	Specifies whether to include all projects in the search (`true` to include).
`includedProjects`	Array of Strings	Yes	A list of specific project keys to include in the search ().
`includedBuilds`	Array of Objects	Yes	Builds to consider during cleanup.
`name`	String	Yes	The name of the build.
`projectKey`	String	Yes	The project identifier associated with the build. This key is obtained from the Project Settings screen. Leave the field blank to apply at a global level.
`excludeBuildsWithReleaseBundles`	Boolean	No	Specifies whether to include builds with release bundles (true to exclude)
`createdBeforeInDays`	Integer	Yes	Specifies the time frame for filtering based on item creation date (for example, 40 days).

Sample Response:

The contents of the response are identical to the Request.

Response Error Codes

Code	Description
400	Validation errors.
404	A policy with the specified key does not exist.
500	Internal server error.