CreateExternalBackupJob

POST {{baseUrl}}/externalBackupJobs

Creates a new backup resource and returns the information the caller needs to back up an on-premises Oracle Database to Oracle Cloud Infrastructure.

Note: This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud for more information.

Request Body

{"availabilityDomain"=>"<string>", "compartmentId"=>"<string>", "dbVersion"=>"<string>", "dbName"=>"<string>", "externalDatabaseIdentifier"=>"<long>", "displayName"=>"<string>", "characterSet"=>"<string>", "ncharacterSet"=>"<string>", "databaseMode"=>"RAC", "databaseEdition"=>"ENTERPRISE_EDITION", "dbUniqueName"=>"<string>", "pdbName"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or
server error without risk of executing that same action again. Retry tokens expire after 24
hours, but can be invalidated before then due to conflicting operations (for example, if a resource
has been deleted and purged from the system, then a retry of the original creation request
may be rejected).
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;backupId&quot;:&quot;\u003cstring\u003e&quot;,&quot;provisioning&quot;:&quot;\u003cboolean\u003e&quot;,&quot;swiftPath&quot;:&quot;\u003cstring\u003e&quot;,&quot;bucketName&quot;:&quot;\u003cstring\u003e&quot;,&quot;userName&quot;:&quot;\u003cstring\u003e&quot;,&quot;tag&quot;:&quot;\u003cstring\u003e&quot;,&quot;swiftPassword&quot;:&quot;\u003cstring\u003e&quot;}