Retrieve Details of All Backup Configurations

get

/backupservice/v1/configuration

This endpoint is not available on Oracle Cloud Machine.

Retrieve details for all backup configuration objects the current user has permission to access.

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

There are no request parameters for this operation.

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : BackupConfiguration
Type: object
Show Source
Nested Schema : Interval
Type: object
There are two kinds of Intervals. Each Interval has its own JSON format. Your Interval field should look like one of the following:

  • "interval":{"Hourly":{"hourlyInterval":2}}
  • {"DailyWeekly":{"daysOfWeek":["MONDAY"],"timeOfDay":"03:15","userTimeZone":"America/Los_Angeles"}}

Days of the week is any day of the week fully capitalized (MONDAY, TUESDAY, etc). The user time zone is any IANA user timezone. For example user time zones see List of IANA time zones.

Match One
Show Source

401 Response

Unauthorized.

500 Response

The server encountered an error handling this request.

Examples

cURL Command

The following example shows how to retrieve details about all backup configurations 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/configuration/
  • 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/configuration/Compute-acme/jack.jones@example.com/backupConfigVol1",
    "runAsUser": "/Compute-acme/jack.jones@example.com",
    "name": "/Compute-acme/jack.jones@example.com/backupConfigVol1",
    "enabled": true,
    "backupRetentionCount": 2,
    "nextScheduledRun": "2016-10-25T21:25:12.898Z",
    "interval": {
      "Hourly": {
        "hourlyInterval": 12
      }
    },
    "volumeUri": "/storage/volume/Compute-acme/jack.jones@example.com/vol1",
    "description": null,
    "tagId": "63ed3bec-5da2-42d2-9f6a-6440a5c91567"
  },
  {
    "uri": "https://api-z999.compute.us0.oraclecloud.com:443/backupservice/v1/configuration/Compute-acme/jack.jones@example.com/backupConfigWeeklyVol2",
    "runAsUser": "/Compute-acme/jack.jones@example.com",
    "name": "/Compute-acme/jack.jones@example.com/backupConfigWeeklyVol2",
    "enabled": false,
    "backupRetentionCount": 2,
    "nextScheduledRun": "2016-09-28T04:00:00Z",
    "interval": {
      "DailyWeekly": {
        "daysOfWeek": [
          "WEDNESDAY",
          "FRIDAY"
        ],
        "timeOfDay": "04:00",
        "userTimeZone": "GMT"
      }
    },
    "volumeUri": "/storage/volume/Compute-acme/jack.jones@example.com/vol1",
    "description": null,
    "tagId": "4b47cfac-ab33-44fa-a8ae-2dc3f333a44b"
  }
]