Description: Returns the status of the restore process based on the specified duration and policy key.
Note
This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users.
Since: Artifactory 7.27.3
Security: Requires an admin user
Usage: GET /api/retention/restore/executions?from=<number>&to=<number>
Produces: application/json
URL Parameters:
Parameters | Type | Description | Required/Optional |
---|---|---|---|
| string | The date range (in epoch format) for the restore status. | Optional |
| string |
Sample Request:
GET /api/retention/restore/executions
Sample Response:
Note
In the API response, the last execution is displayed on top.
{ "state": "COMPLETE", "completedNumberOfArtifacts": 1, "failedNumberOfArtifacts“: 0, "totalNumberOfArtxfacts": 1, "progressPercentage": 100, "startTime": 1623768273379, "finishTime": 1623768327866, "totalByteSize": 9811, "successByteSize": 9811, "failureByteSize": 0, "destination": "gen-2" }
The response displays the following information:
Property | Description |
---|---|
| The destination from which the artifacts were restored. It can be one of the following:
|
| Shows the status of the last policy run. It can be one of the following:
|
| Total number of artifacts to be archived. |
| Total number of artifacts that were archived. |
| Total number of artifacts that could not be archived. |
| The progress of the policy (in percentage). |
| Time when the policy started executing. Value is in Unix epoch time in milliseconds. |
| Time when the policy finished executing. Value is in Unix epoch time in milliseconds. |
| The total size of the artifacts included in the policy. |
| The size of the artifacts that were archived. |
| The size of the artifacts that couldn't be archived. |
Status:
200: Success