Jump to

• Request
• Response
• Examples

Start a Backup Operation

post

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/backups

Starts an on-demand backup operation on an Oracle Integration Classic instance.

Request

Supported Media Types

• application/json

Path Parameters

• identityDomainId: string
  Name of the identity domain for the service account
• service_name: string
  Name of the Integration Cloud instance

Header Parameters

• X-ID-TENANT-NAME: string
  Identity domain ID for the Oracle Integration Classic account.

Body ()

JSON payload for this REST endpoint

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

• backupType(optional): string
  The backup type (Full or Incremental..) .
• databaseIncluded(optional): string
  Should Database be included in backup(not available for exadata DB)
• keepForever(optional): string
  Prevent the automatic deletion of the backup after the retention period has elapsed.
• notes(optional): string
  notes

{
    "type":"object",
    "properties":{
        "backupType":{
            "type":"string",
            "description":"The backup type (Full or Incremental..) ."
        },
        "databaseIncluded":{
            "type":"string",
            "description":"Should Database be included in backup(not available for exadata DB)"
        },
        "keepForever":{
            "type":"string",
            "description":"Prevent the automatic deletion of the backup after the retention period has elapsed."
        },
        "notes":{
            "type":"string",
            "description":"notes"
        }
    },
    "title":"Request Body"
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted

Body ()

Root Schema : accepted-response

Type: object

Show Source

• jobId(optional): string
  Job ID of the operation.
• message(optional): string
  System message that describes the operation. For example: Submitted job to create service [{serviceName}] in domain [{identityDomainId}].

{
    "properties":{
        "message":{
            "type":"string",
            "description":"System message that describes the operation. For example: <code>Submitted job to create service [{serviceName}] in domain [{identityDomainId}].</code>"
        },
        "jobId":{
            "type":"string",
            "description":"Job ID of the operation."
        }
    }
}

Back to Top

Examples

The following example shows how to initiate a backup for an Oracle Integration Classic Instance by submitting a POST request on the REST resource using cURL.

Note:

The command in this example uses the URL structure https://example.com/resource-path, where example.com is the Oracle Cloud server to contact for your identity domain.

cURL Command

curl -i -X POST -u jstein:Password -d @backup.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" http://example.com/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/IntegrationCloud/instances/ExampleInstance/backups 

Example of Request Header

The following shows an example of the response header.

headers: Content-Type:application/json
Authorization: <Basic Auth credentials>
X-ID-TENANT-NAME: <identity domain>

Example of Request Body

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

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

Back to Top