Jump to

• Request
• Response
• Examples

Start a Backup Operation

post

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

Starts an on-demand backup operation on an API Platform Cloud Service instance.

After you back up your API Platform Cloud Service instance, you must separately back up the DBaaS instance associated with 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 account.
• serviceId: string
  Name of the API Platform Cloud Service 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

The request body, in JSON format, required to be sent with backup requests.

Show Source

• databaseIncluded: boolean
  Indicates if the database associated with the service instance should also be backed up. This value should be false.
• expirationDate: string
  Expiration date of the backup, following this format: YYYY-MM-DDTHH:MM:SS (like 2016-12-27T10:00:46). Set this value to null if the backup should have no expiration date.
• full: boolean
  true if this is a full backup; false if this is an incremental backup.
• notes: string
  Notes about the backup operation.

{
    "title":"Request Body",
    "type":"object",
    "description":"The request body, in JSON format, required to be sent with backup requests.",
    "properties":{
        "databaseIncluded":{
            "type":"boolean",
            "description":"Indicates if the database associated with the service instance should also be backed up. This value should be <code>false</code>."
        },
        "expirationDate":{
            "type":"string",
            "description":"Expiration date of the backup, following this format: YYYY-MM-DDTHH:MM:SS (like 2016-12-27T10:00:46). Set this value to <code>null</code> if the backup should have no expiration date."
        },
        "full":{
            "type":"boolean",
            "description":"<code>true</code> if this is a full backup; <code>false</code> if this is an incremental backup."
        },
        "notes":{
            "type":"string",
            "description":"Notes about the backup operation."
        }
    }
}

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

Examples

The following example shows how to initiate an on-demand backup of an Oracle API Platform Cloud Service instance 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 @backup.json 
-https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/apics/backups

Example of Request Body

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

{
   "databaseIncluded":false,
   "expirationDate":null,
   "full":true,
   "notes":"On-demand full backup request."
}

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 202 Accepted
Date: Wed, 23 Nov 2016 11:00:00 GMT
Transfer-Encoding: chunked
Location: https://example.com:7103/paas/api/v1.1/activitylog/apics/job/26358
Content-Type: application/json
X-ORACLE-DMS-ECID: 7077e58cc81a37d2:-4cd90f8:15878a7e3f0:-8000-0000000000005fa2
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 information you can use to find the status of your backup request.

{
	"operationName": "start-backup",
	"target_uri": "https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/apics/backups/1479898800355",
	"job_id": "26358"
}