Get Restore Process Status

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 /artifactory/api/retention/restore/executions?from=<number>&to=<number>

Produces: application/json

URL Parameters:

Parameters	Type	Description	Required/Optional
`from`	string	The date range (in epoch format) for the restore status.	Optional
`to`	string	The date range (in epoch format) for the restore status.	Optional

Sample Request:

GET https://[JFrogPlatformURL]/artifactory/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
`destinationConfiguration`	The destination from which the artifacts were restored. It can be one of the following: Original/Central Fallback Location
`lastRunStatus`	Shows the status of the last policy run. It can be one of the following: PENDING: The policy has never been executed. IN_PROGRESS: The policy execution is in progress. IN_PROGRESS_WITH_ERRORS: The policy execution is in progress but encountered one or more errors. COMPLETE: The policy was executed successfully without any errors. COMPLETE_WITH_ERRORS: The policy executed, but encountered one or more errors. FAILED: The policy execution failed.
`totalNumberOfArtifacts`	Total number of artifacts to be archived.
`completedNumberOfArtifacts`	Total number of artifacts that were archived.
`failedNumberOfArtifacts`	Total number of artifacts that could not be archived.
`progressPercentage`	The progress of the policy (in percentage).
`startTime`	Time when the policy started executing. Value is in Unix epoch time in milliseconds.
`finishTime`	Time when the policy finished executing. Value is in Unix epoch time in milliseconds.
`totalByteSize`	The total size of the artifacts included in the policy.
`successByteSize`	The size of the artifacts that were archived.
`failureByteSize`	The size of the artifacts that couldn't be archived.

Status:

200: Success