REST API for Oracle Database Exadata Cloud at Customer (Gen 1/OCI-C)

Start a Backup Operation

post

/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}/backups

Starts an on-demand backup for an Exadata Cloud at Customer database deployment.

Request

Supported Media Types

application/json

Path Parameters

identityDomainId: string
The value depends on the type of Exadata Cloud at Customer account that is used to make the request:
- For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.
- For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which is a character string beginning with idcs-.
serviceId: string

Name of the Exadata Cloud at Customer database deployment.

Header Parameters

Authorization: string

Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
X-ID-TENANT-NAME: string
The value depends on the type of Exadata Cloud at Customer account that is used to make the request:
- For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.
- For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which is a character string beginning with idcs-.
For more information, see Security, Authentication and Authorization.

Root Schema : Request Body for backup

Type: object

Title: Request Body for backup

Show Source

keepForever(optional): boolean

Specify true for a long term backup. Valid values are true or false. Default is false.

{
    "title":"Request Body for backup",
    "type":"object",
    "description":"",
    "properties":{
        "keepForever":{
            "type":"boolean",
            "description":"Specify <code>true</code> for a long term backup. Valid values are <code>true</code> or <code>false</code>. Default is <code>false</code>."
        }
    }
}

Response

202 Response

Accepted. See Status Codes for information about other possible HTTP status codes.

Headers

Location: string

A REST URI you can use to check the progress and completion of the backup operation, as described in View the Job Status of an Operation.

Examples

The following example shows how to start an on-demand backup operation by submitting a POST request on the REST endpoint using cURL.

In this example, the identity domain is usexample and the Oracle Cloud user name and password are serviceadmin and Pa55_word. The name of the Exadata Cloud at Customer database deployment being acted on is db12c.

cURL Command

In the following cURL command, the request body is provided directly in the -d option.

curl -i -X POST --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample" -H "Content-Type:application/json" -d '{ }' https://dbaas.oraclecloud.com/paas/service/dbcs/api/v1.1/instances/usexample/db12c/backups

HTTP Status Code and Response Headers

HTTP/2.0 202
server: Oracle-Application-Server-11g
strict-transport-security: max-age=31536000;includeSubDomains
location: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/status/backup/job/12223443
content-language: en
access-control-allow-origin: *
access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
retry-after: 60
access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
x-oracle-dms-ecid: 005KB7i1OrR6uHFpR05Eid0007dd0002lh
x-oracle-dms-ecid: 005KB7i1OrR6uHFpR05Eid0007dd0002lh
service-uri: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/db12c
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Mon, 29 May 2017 23:20:16 GMT