Stop a Running Cleanup Policy API

JFrog REST APIs

Content Type
REST API
ft:sourceType
Paligo

Description: This REST API is called to stop a cleanup policy that is currently running. Once a policy has been stopped, it cannot be resumed from the point where it stopped.

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

Produces: application/json

Usage: PUT /artifactory/api/cleanup/policies/runs/{runId}

{"action": <action>}

Query Parameters:

Field

Type

Description

runId

string

An ID that identifies the run. This ID is received when calling the Manually Run Cleanup Policy API.

action

string

Use the stop action in to stop the policy run.

Sample Query:

The example below shows a request to stop the run with runId = 1.

PUT /artifactory/api/cleanup/policies/runs/1 {"action": "stop"}

Sample Responses:

202 ACCEPTED "Action: 'stop' on task ID: '1' performed successfully"

Response Error Codes

Code

Description

400

Validation errors.

404

No cleanup policy with run ID: runId was found