Start a Backup Operation
/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/backups
Starts an on-demand backup operation on an Oracle SOA Cloud Service instance.
After you back up your Oracle SOA Cloud Service instance, you must separately back up the DBaaS instance associated with your service instance.
Request
- application/json
-
domainName: string
Name of the identity domain for the Oracle Cloud Service account.
-
serviceName: string
Name of the Oracle SOA Cloud Service instance.
object
Request Body
-
backupType:
string
INCREMENTAL
,FULL
. -
databaseIncluded:
boolean
Indicates if the database associated with the service instance should also be backed up. This value should be
false
. -
expirationDate:
string
Deprecated. To set a null expiration date for full backups, use
keepForever
set to true. -
keepForever:
boolean
Flag that specifies whether to keep the backup indefinitely. This attribute replaces
expirationDate
.Set this value to true to keep the backup indefinitely or until it is deleted manually. (This is the same behavior as
expirationDate
set to null.) Set this value tofalse
to delete the backup at the end of the default retention period for the service instance's backups.Note: If the associated Oracle Database Cloud Service database deployment is hosting an Oracle Real Application Clusters (RAC) database, a database backup cannot be performed as part of the on-demand backup operation when the
keepForever
value is set totrue
.
Response
- application/json
202 Response
object
-
job_id:
string
Job ID for the Backup operation.
-
operationName:
string
Name of the Backup operation. Depending on the operation, name can be
start-backup
,delete-backup
, orrestore-backup
-
target_uri:
string
Target Backup URL of the Oracle SOA Cloud Service instance.
Examples
The following example shows how to initiate 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 username:Password1! -d @backup.json -H "Content-type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest-server_url/paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances/{serviceName}/backups
Example of Request Body
The following example shows the request document in JSON format.
{ "backupType": "FULL", "databaseIncluded": "false" }
Example of Response Body
{ "operationName": "backups", "target_uri": "http://{host}:{port}/paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances/{serviceName}/backups/1484982217086", "job_id": "2613" }