Description: This REST API is called to stop a smart archiving 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/archive/v2/policies/runs/{runId}
{"action": <action>}
Query Parameters:
Field | Type | Description |
|---|---|---|
| string | An ID that identifies the run. This ID is received when calling the Run Smart Archiving Policy API. |
| string | Use the |
Sample Query:
The example below shows a request to stop the run with runId = 1.
PUT /artifactory/api/archive/v2/policies/runs/1 {"action": "stop"}Sample Responses:
202 ACCEPTED "Action: 'stop' on task ID: '1' performed successfully"
Response Error Codes
Code | Description |
|---|---|
202 | The request was successful. |
400 | Validation errors. |
401 | Bad Credentials. |
403 | Unauthorized. |
404 | No archive policy with run ID: |
500 | Internal server error. |