Restore from Archive

post

https://{jfrog_url}/artifactory/api/retention/restore

Triggers restoration of multiple items from the Archive. An admin can choose one of the following options - Restore items to the original location and provide fallback repository in case the original location was deprecated. Restore to a dedicated central repository. Important Restore operation only moves the items back to the Warm instance location and does not delete them from the Cold instance. This Cold Storage feature is available only for Artifactory Enterprise and Enterprise+ users.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

restoreType

string

enum

required

Determines whether to restore a package (PACKAGE_RESTORE) or artifacts (ARTIFACT_RESTORE). The default value is ARTIFACT_RESTORE.

Allowed:

restoreToOriginal

boolean

Set whether or not to restore to the original artifact location (saved on the Cold instance). Required if centralDestinationPath is not set.

fallbackDestinationPath

string

If restoreToOriginal is set as true and the original location does not exist anymore, restore to this fallback location. fallbackDestinationPath must contain at least the repository key. Required if restoreToOriginal is set.

centralDestinationPath

string

The repository key where the files need to be restored. The files will be restored to this repository according to its original path hierarchy. Required if restoreToOriginal is not set.

addNamespace

boolean

This is set as true by default and you do not have to include the namespace when adding items for itemsToRestore. When set as false, you must include the namespace when adding items for itemsToRestore.

itemsToRestore

array of strings

required

Comma-separated list of the items or paths to be restored. Format - ["<repository_name>/path/to/file", "<repository_name>/path/to/folder/", ...]. Note, Folder paths must end with a / while file paths must not.

itemsToRestore*

Responses

202Accepted - Restore process was initialized successfully.

401Bad Credentials - The provided authentication is invalid.

403Permission Denied - The user does not have the necessary permissions to perform this action.

500Internal Server Error