Jump to

• Request
• Response
• Examples

Start a Restore Operation

post

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/APICS/instances/{serviceId}/restoredbackups

Starts a restore operation on an API Platform Cloud Service - Classic Instance using the latest backup or a backup specified by a backup ID.

Restore the DBaaS instance associated with your API Platform Cloud Service - Classic 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.

Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.

Request

Supported Media Types

• application/json

Path Parameters

• identityDomainId: string
  Name of the identity domain for the API Platform Cloud Service - Classic account.
• serviceId: string
  Name of the API Platform Cloud Service - Classic instance.

  Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.

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.

Body ()

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

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

{
    "title":"Request Body",
    "type":"object",
    "description":"",
    "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

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 recovery operation, as described in View the Job Status of an Operation.

Back to Top

Examples

The following example shows how to restore an Oracle API Platform Cloud Service - Classic instance from a backup by submitting a POST request on the REST resource using cURL. For more information about cURL, see cURL Examples.

curl -i -X POST 
-u apicsadmin:password 
-H "Content-Type: application/json"
-d @restore.json 
https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/apics/restoredbackups

Example of Request Body

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

{
	"backupId": "1479898800355",
	"notes": "restoring from backup"
}

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 202 Accepted
Date: Wed, 23 Nov 2016 11:10:51 GMT
Transfer-Encoding: chunked
Location: https://example.com:7103/paas/api/v1.1/activitylog/apics/job/26361
Content-Type: application/json
X-ORACLE-DMS-ECID: 7077e58cc81a37d2:-4cd90f8:15878a7e3f0:-8000-0000000000005fc6
X-Frame-Options: DENY
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Access-Control-Allow-Origin: *

Example of Response Body

The following example shows the contents of the response body in JSON format, including including information you can use to find the status of your restore request.

{
	"operationName": "restore-backup",
	"job_id ": "26361",
	"target_uri": "https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/apics/restoredbackups/26361"
}

Back to Top