REST API for Oracle SOA Cloud Service on Oracle Public Cloud Machine

Create a New Service Backup

post

/api/v1.1/instances/{identityId}/{serviceId}/backups

Creates a new backup for a service instance.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : BackupServiceInstancePayload

Type: object

Properties

expirationDate: Type: string

Date and time that the backup will be deleted automatically from storage. For full backups, you can set this value to null (no quotes) to specify no expiration date.
By default, backups are retained for the default retention period defined in the backup configuration;
notes: Type: string

Free-form text to provide additional information about the backup.

Response

Supported Media Types

application/json

202 Response

Accepted

Body

Root Schema : BackupTheInstanceResponse

Type: object

Properties

jobId: Type: string

Job ID for the backup operation.
operationName: Type: string

Operation performed. Set to: start-backup.
target_uri: Type: string

URI of the backup resource.

Examples

The following example shows how to initiate an on-demand backup for an Oracle SOA Cloud Service instance by submitting a POST request on the REST resource using cURL. For more information, see Use cURL .

cURL Command

curl -i -X POST -u joe@example.com:Welcome1! -d @backup.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://api-host/paas/service/soa/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance/backups

Note:: This example uses the URL prefix for the United States ( soacs). For information about the URL prefixes for other regions of the world, see Send Requests.

Example of Request Body

The following shows an example of the request body in JSON format.

{
   "expirationDate":null,
   "full":true,
   "note":"On-demand backup request."
}

Example of Response Header

The following shows an example of the response header:

HTTP/1.1 202 Accepted
Date: Wed, 04 Feb 2015 20:17:03 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following shows an example of the response body in JSON format, including the backup URI that you can use to view, update, or delete the backup.

{
    "operationName":"start-backup",
    "target_uri":"https:\/\/api-host\/paas\/service\/soa\/api\/v1.1\/instances\/ExampleIdentityDomain\/ExampleInstance\/backups\/1406814125722",
    "job_id":"1035"}
}