Retrieves Details of the Specified Backup



This endpoint is not available on Oracle Cloud Machine.

Get the backup specified by the provided multi-part object name.

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.


Supported Media Types
Path Parameters
  • Pattern: [(^/$|^(/[\w@\.-]+)+$)]{1,255}
    Multi-part name of Backup to get


Supported Media Types

200 Response

Successfully retrieved backup object by name.
Body ()
A Backup Job.
Root Schema : Backup
Type: object
A Backup Job.
Show Source

401 Response

Unauthorized or backup does not exist.

404 Response

The URL does not refer to a valid resource.

500 Response

The server encountered an error handling this request.


cURL Command

The following example shows how to retrieve details of a backup 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"
  • 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.

  • 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.

  • acme and are example values. Replace acme with the identity domain ID of your Compute Classic account, and with your user name.

Example of Response Body

The following example shows the response body in JSON format.

  "uri": "",
  "runAsUser": "/Compute-acme/",
  "name": "/Compute-acme/",
  "backupConfigurationName": "/Compute-acme/",
  "volumeUri": "/storage/volume/Compute-acme/",
  "errorMessage": "",
  "detailedErrorMessage": "",
  "state": "COMPLETED",
  "description": null,
  "bootable": false,
  "shared": false,
  "snapshotUri": "/storage/snapshot/Compute-acme/",
  "snapshotSize": "1073741824b",
  "tagId": "22e6eaf1-3f2b-43b3-9505-63abec384e18"