Restore Backup - Only for OCI (Gen 2) Environments

In OCI (Gen 2) environments, you can restore an available backup snapshot archived by Oracle in Oracle Object Storage (that is, copy it to the environment).

To view available backup snapshots, see List Backups. If a backup snapshot is available, you can copy it to the current environment using the Restore Backup API.

After copying the backup, you can archive it or use it to restore the current environment by yourself. With the List Backups and Restore Backup APIs, you no longer have to create a service request to request a backup from an OCI environment.

This REST API is version v2.

Required Roles

Service Administrator

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See About the REST APIs. Using this REST API requires prerequisites. See Prerequisites.

REST Resource

POST /interop/rest/v2/backups/restore

Request

Supported Media Types: application/json

Parameters:

The following table summarizes the POST request parameters.

Table 7-41 Parameters

Name Description Type Required Default
backupName The name of the backup snapshot, as listed in the response for List Backups Payload Yes None
targetName The name of the backup snapshot, without an extension, in the target environment Payload No If you do not specify this parameter, the backup snapshot is restored to the target environment pre-pended with the current timestamp, for example, 2022-03-10T06:37:48_Artifact_Snapshot.zip or 2022-03-30T06:22:35_EPRCS_Backup.tar.gz.

Example of Request Body

{
	"backupName": "2022-02-16T21:00:02/Artifact_Snapshot_2021-12-16T21:00:02",
	"parameters": {
		"targetName": "Backup_16Dec"
	}
}

Response

Supported Media Types: application/json

Parameters:

Table 7-42 Parameters

Name Description
details In the case of errors, details are published with the error string
status See Migration Status Codes
links Detailed information about the link
href Links to API call or status API
action The HTTP call type
rel Possible values: self or Job Status. If the value is set to Job Status, you can use the href to get the status of the copy snapshot
intermittentStatus Status of each step performed; can be polled regularly from the job status URL

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "links": [
        {
            "rel": "self",
            "href": "http://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/backups/restore",
            "data": null,
            "action": "POST"
        },
        {
            "rel": "Job Status",
            "href": "http://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/status/jobs/4534730166024804",
            "data": null,
            "action": "GET"
        }
    ],
    "details": null,
    "status": -1,
    "items": null
}
Common Functions