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

Archive and Download a Backup

post

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

Downloads a backup and stores it locally in block storage on the administration server.

Request

Supported Media Types

application/json

Path Parameters

backupId: Type: string

Required: true

ID of the backup to be archived.

Body Parameter

The request body defines the details of the archive or download backup request. Bold indicates a required value.

Root Schema : ArchiveOrDownloadBackupPayload

The request body defines the details of the archive or download backup request. Bold indicates a required value.

Properties

local: Type: boolean

Required: true

Flag that specifies whether the backup is to be downloaded and stored locally in block storage on the Administration Server (true), or archived and stored remotely on the Oracle Storage Cloud Service container (false).

Response

Supported Media Types

application/json

200 Response

Accepted

Body

The response body contains information about the archive or download backup operation.

Root Schema : ArchiveOrDownloadBackupResponse

The response body contains information about the archive or download backup operation.

Properties

jobId: Type: string

Job ID for the archive or download backup operation.
operationName: Type: string

Name of operation performed. Set to: move-backup
target_uri: Type: string

URI of the archive or download backup resource.

Examples

The following example shows how to store a 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 @archive.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/1390442367140

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 example shows the contents of the response body in JSON format.

{
   "local":false
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Wed, 04 Feb 2015 21:24:33 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":"move-backup",
   "target_uri":"https:\/\/api-host\/paas\/service\/soa\/api\/instances\/ExampleIdentityDomain\/ExampleInstance\/backups\/1390442367140",
   "job_id":"101"
}