Retrieve Details of all Restores

get

/backupservice/v1/restore

This endpoint is not available on Oracle Cloud Machine.

Returns a json object of restore objects.

Required Role: To complete this task, you must have the Compute_Monitor or Compute_Operationsrole. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.

Request

Supported Media Types
Query Parameters

Response

Supported Media Types

200 Response

Returns list of Restore objects.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : Restore
Type: object
Show Source

401 Response

Unauthorized.

404 Response

Unknown query parameter.

500 Response

The server encountered an error handling this request.

Examples

cURL Command

The following example shows how to retrieve details about all restores in the / container by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -X GET 
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Accept: application/oracle-compute-v3+json"
     https://api-z999.compute.us0.oraclecloud.com/backupservice/v1/restore/
  • COMPUTE_COOKIE is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication.

  • api-z999.compute.us0.oraclecloud.com is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests.

Example of Response Body

The following example shows the response body in JSON format.

[
  {
    "uri": "https://api-z999.compute.us0.oraclecloud.com:443/backupservice/v1/restore/Compute-acme/jack.jones@example.com/vol1-RESTORE-A",
    "runAsUser": "/Compute-acme/jack.jones@example.com",
    "name": "/Compute-acme/jack.jones@example.com/vol1-RESTORE-A",
    "backupName": "/Compute-acme/jack.jones@example.com/vol1-BACKUP-A",
    "backupConfigurationName": "/Compute-acme/jack.jones@example.com/backupConfigVol1",
    "volumeUri": "/storage/volume/Compute-acme/jack.jones@example.com/restored-example-volume",
    "errorMessage": "",
    "detailedErrorMessage": "",
    "state": "COMPLETED",
    "bootable": false,
    "description": null
  },
  {
    "uri": "https://api-z999.compute.us0.oraclecloud.com:443/backupservice/v1/restore/Compute-acme/jack.jones@example.com/vol1-RESTORE-B",
    "runAsUser": "/Compute-acme/jack.jones@example.com",
    "name": "/Compute-acme/jack.jones@example.com/vol1-RESTORE-B",
    "backupName": "/Compute-acme/jack.jones@example.com/vol1-BACKUP-A",
    "backupConfigurationName": "/Compute-acme/jack.jones@example.com/backupConfigVol1",
    "volumeUri": "/storage/volume/Compute-acme/jack.jones@example.com/restored-example-volume",
    "errorMessage": "Volume already exists. URI: /storage/volume/Compute-acme/jack.jones@example.com/restored-example-volume",
    "detailedErrorMessage": "",
    "state": "FAILED",
    "bootable": false,
    "description": null
  }
]