Retrieve Details of all Backups

get

/backupservice/v1/backup

This endpoint is not available on Oracle Cloud Machine.

Retrieves details of the backups that are available and match the specified query criteria. If you don't specify any query criteria, then details of all the backups in the container are displayed. To filter the search results, you can pass one or more of the documented query parameters by appending them to the URI in the following syntax:

?parameter1=value1&parameter2=value2&parameterN=valueN

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

Successfully retrieved backup objects for query.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : Backup
Type: object
A Backup Job.
Show Source

401 Response

Unauthorized.

404 Response

Unknown query parameters.

500 Response

The server encountered an error handling this request.

Examples

cURL Command

The following example shows how to retrieve details about all that backup objects that you have permission to view 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/backup/
  • 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/backup/Compute-acme/jack.jones@example.com/backupConfigWeeklyVol1/930d16e4-83af-4119-9f32-691d4541e5a7",
    "runAsUser": "/Compute-acme/jack.jones@example.com",
    "name": "/Compute-acme/jack.jones@example.com/backupConfigWeeklyVol1/930d16e4-83af-4119-9f32-691d4541e5a7",
    "backupConfigurationName": "/Compute-acme/jack.jones@example.com/backupConfigWeeklyVol1",
    "volumeUri": "/storage/volume/Compute-acme/jack.jones@example.com/vol1",
    "errorMessage": "",
    "detailedErrorMessage": "",
    "state": "COMPLETED",
    "description": null,
    "bootable": false,
    "shared": false,
    "snapshotUri": "/storage/snapshot/Compute-acme/jack.jones@example.com/vol1/5fe6bc70a4c9f0fcaf5a094a01f22364f77952a225e862530c36fb59ff9aaa28",
    "snapshotSize": "1073741824b",
    "tagId": "9d2b05f1-927b-4083-92dd-b565530e373d"
  },
  {
    "uri": "https://api-z999.compute.us0.oraclecloud.com:443/backupservice/v1/backup/Compute-acme/jack.jones@example.com/vol1-BACKUP-B",
    "runAsUser": "/Compute-acme/jack.jones@example.com",
    "name": "/Compute-acme/jack.jones@example.com/vol1-BACKUP-B",
    "backupConfigurationName": "/Compute-acme/jack.jones@example.com/backupConfigWeeklyVol2",
    "volumeUri": "/storage/volume/Compute-acme/jack.jones@example.com/vol1",
    "errorMessage": "",
    "detailedErrorMessage": "",
    "state": "COMPLETED",
    "description": null,
    "bootable": false,
    "shared": false,
    "snapshotUri": "/storage/snapshot/Compute-acme/jack.jones@example.com/vol1/b2faedfd2d62b5ddbd856bf557235df49e6fcfba5ba91ccddc37893adc73757e",
    "snapshotSize": "1073741824b",
    "tagId": "22e6eaf1-3f2b-43b3-9505-63abec384e18"
  }
]