Jump to

• Request
• Response
• Examples

Start a Restore Operation

post

/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/restoredbackups

Starts a restore operation on an Oracle SOA Cloud Service instance using the latest backup or a backup specified by a backup ID.

Restore the DBaaS instance associated with your Oracle SOA Cloud Service instance before restoring your service instance.

Note: Some configuration details, like access rules, security lists, and security applications, may not be backed up and may need to be restored manually after you restore an instance from a backup.

Request

Supported Media Types

• application/json

Path Parameters

• domainName: string
  Name of the identity domain for the Oracle Cloud Service account.
• serviceName: string
  Name of the Oracle SOA Cloud Service instance.

Body ()

Root Schema : start-recovery

Type: object

The response body contains information about the restore operation.

Show Source

• backupId: string
  The ID number of the backup you want to restore from.
• notes: string
  Notes about the restoration.

{
    "required":[
        "backupId",
        "notes"
    ],
    "description":"The response body contains information about the restore operation.",
    "properties":{
        "backupId":{
            "type":"string",
            "description":"The ID number of the backup you want to restore from."
        },
        "notes":{
            "type":"string",
            "description":"Notes about the restoration."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted.

Body ()

Root Schema : backup-response

Type: object

The response body contains information about the Backup operation.

Show Source

• 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, or restore-backup
• target_uri: string
  Target Backup URL of the Oracle SOA Cloud Service instance.

{
    "required":[
        "operationName",
        "job_id",
        "target_uri"
    ],
    "description":"The response body contains information about the Backup operation.",
    "properties":{
        "operationName":{
            "type":"string",
            "description":"Name of the Backup operation. Depending on the operation, name can be <code>start-backup</code>, <code>delete-backup</code>, or <code>restore-backup</code>"
        },
        "job_id":{
            "type":"string",
            "description":"Job ID for the Backup operation."
        },
        "target_uri":{
            "type":"string",
            "description":"Target Backup URL of the Oracle SOA Cloud Service instance."
        }
    }
}

Back to Top

Examples

The following example shows how to restore 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}/restoredbackups/

Example of Request Body

The following example shows the request body in JSON format.

{ 
	"backupId": "bc1b13d4-9a0f-4f99-8701-e203f645f732", 
	"notes": "RestoreBackup automation test."
}

Example of Response Header

The following example shows the response header:

-u '{userName}:{password}'
Content-type:application/json
X-ID-TENANT-NAME: {identityDomainId}

Example of Response Body

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

{ 
	"operationName": "restore-backup",
	"job_id": "2640", 
	"target_uri": "http://{host}:{port}/paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances/{serviceName}/restoredbackups/2640"
}

Back to Top