Update Build Cleanup Policy

put

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

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

policyKey

string

required

The ID that identifies the policy.

Body Params

key

string

required

A unique identifier for the cleanup policy. A minimum of three characters is required, including letters, numbers, underscore and hyphen.

description

string

length ≤ 256

A brief description of the cleanup policy.

cronExp

string

A cron expression specifying when the cleanup job will 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.

itemType

string

enum

required

The type of items to clean up (build). This field is required.

Allowed:

durationInMinutes

integer

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

enabled

boolean

Indicates if the cleanup policy is active (true) or disabled (false). A cleanup policy must be created inactive.

deleteArtifacts

boolean

Deletes the artifacts associated with the build (true to delete).

skipTrashcan

boolean

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.

searchCriteria

object

required

Responses

200Success

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error