Jump to

• Request
• Response

Initiate an On-demand Backup

post

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

Initiates an on-demand backup for an Oracle Data Hub Cloud Service instance.

For complete information about scheduled automated backups, contents of backups, and where backups are stored, see About Backing Up and Restoring Databases in Administering Oracle Data Hub Cloud Service.

Request

Supported Media Types

• application/json

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle Data Hub Cloud Service account.
• serviceId: string
  Name of the Oracle Data Hub Cloud Service instance.

Body ()

The request body contains details of the on-demand backup request.

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

• backupType: string
  The backup type (Full or Incremental..).
• keepForever: string
  Prevent the automatic deletion of the backup after the retention period has elapsed.
• notes: string
  Enter notes for this backup.

{
    "type":"object",
    "properties":{
        "backupType":{
            "type":"string",
            "description":"The backup type (Full or Incremental..)."
        },
        "keepForever":{
            "type":"string",
            "description":"Prevent the automatic deletion of the backup after the retention period has elapsed."
        },
        "notes":{
            "type":"string",
            "description":"Enter notes for this backup."
        }
    },
    "title":"Request Body"
}

Response

Supported Media Types

• application/json

202 Response

Accepted

Body ()

Root Schema : accepted-response

Type: object

Show Source

• jobId: string
  Job ID of the operation.
• message: 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."
        }
    }
}