How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Db Backups API

The dbBackups API from Oracle — 7 operation(s) for dbbackups.

Oracle Db Backups API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include dbBackups. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 10 operations across 7 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 20190415.

Requests are made against a single base URL, http://mysql.{region}.ocp.oraclecloud.com/20190415.

10 operations 7 paths 33 schemas 1 DELETE2 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20190415
Base URL
https://{host}:{port}/ords/
License
Oracle Corporation
Resource Areas
1

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 2 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

dbBackups 10
GET
/backups
List Backups
ListBackups 14 params → 200400401404429500default
POST
/backups
Create DB System Backup
CreateBackup 2 params body → 201400401404409412429500
POST
/backups/actions/copy
Copy a DB system backup to another region.
CopyBackup 3 params body → 202400401404409412429500
DELETE
/backups/{backupId}
Delete a Backup.
DeleteBackup 3 params → 204400401404412429500default
GET
/backups/{backupId}
Get a Backup.
GetBackup 3 params → 200304400401404429500default
PUT
/backups/{backupId}
Update the Backup metadata.
UpdateBackup 3 params body → 200304400401404412429500
POST
/backups/{backupId}/actions/cancelDeletion
Cancel the scheduled deletion of a backup.
CancelBackupDeletion 4 params → 204400401404409412429500
POST
/backups/{backupId}/actions/changeCompartment
Move a DB System Backup from one compartment to another.
ChangeBackupCompartment 4 params body → 204400401404409412429500
POST
/backups/{backupId}/actions/export
Export a DB system backup to an Object Storage bucket.
ExportBackup 3 params body → 202400401404409412429500
POST
/backups/{backupId}/actions/validate
Request to validate the backup by checking the data consistency.
ValidateBackup 4 params body → 202400401404409412429500

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are DbSystemSnapshot (36 properties), Backup (26 properties), BackupSummary (26 properties), DbSystemEndpoint (8 properties). Each schema is shown below with its type and property counts.

BackupValidationDetails
object
Backup validation details.
6 properties
DataStorageDetails
object
Data Storage configuration properties.
2 properties
ReadEndpointDetails
object
The read endpoint of a DB System.
5 properties
UpdateBackupDetails
object
The Backup metadata which can be updated.
6 properties
DestinationConfiguration
object
Configuration variable of a given destination.
2 properties 2 required
PreparedBackupDetails
object
Prepared backup details.
2 properties
DbSystemSnapshot
object
Snapshot of the DbSystem details at the time of the backup
36 properties 8 required
CopyPolicy
object
A policy of a DB system to schedule cross-region DB system backup copy.
2 properties 1 required
EncryptDataDetails
object
Encrypt data details.
2 properties 1 required
DbSystemSnapshotSummary
object
A summary of snapshot of the DB system details at the time of the backup.
3 properties 3 required
CreateBackupDetails
object
Complete information for a Backup.
8 properties 1 required
CopyBackupDetails
object
Details required to copy a DB system backup from its source region to a destination region.
7 properties 3 required
ExportOptions
object
The additional options used while exporting the DB system backup.
3 properties
ValidateBackupDetails
object
Details required to validate backup.
1 property 1 required
ChangeBackupCompartmentDetails
object
OCID of the target compartment for DB System Backup change compartment request.
1 property 1 required
DbSystemEndpoint
object
A particular functional endpoint for access to a DB System, and the properties that apply to it.
8 properties 3 required
SecureConnectionDetails
object
Secure connection configuration details.
2 properties 1 required
Ipv6AddressIpv6SubnetCidrPairDetails
object
Details to assign an IPv6 subnet prefix or IPv6 address to a resource.
2 properties
DatabaseConsoleDetails
object
Database console configuration details.
2 properties 1 required
ExportBackupDetails
object
The parameters required to export a DB system backup.
4 properties 2 required
CompressionOptions
object
The additional compression options used while exporting the DB system backup.
3 properties
RestDetails
object
REST configuration details.
2 properties 1 required
LoggingDestinationConfiguration
object
Configuration parameters for a given destination.
3 properties 3 required
Backup
object
A full or incremental copy of a DB System which can be used to create a new DB System or recover a DB System. To use any of the API operations, you must be aut…
26 properties 9 required
Error
object
Sorry.
2 properties 2 required
TelemetryConfigurationDetails
object
Telemetry configuration details of a DB System or a read replica.
1 property
DeletionPolicyDetails
object
The Deletion policy for the DB System.
3 properties 3 required
MaintenanceDetails
object
The Maintenance Policy for the DB System or Read Replica that this model is included in.
7 properties
PitrPolicy
object
The PITR policy for the DB System.
1 property 1 required
DataStorage
Data Storage information.
MaintenanceDisabledWindow
object
Time window during which downtime-inducing maintenance shall not be performed. Downtime-free maintenance may be performed to apply required security patches.
2 properties 2 required
BackupSummary
object
Details of Backups such as OCID, description, backupType, and so on. To use any of the API operations, you must be authorized in an IAM policy. If you're not a…
26 properties 7 required
BackupPolicy
object
The Backup policy for the DB System.
8 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-dbbackups-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from

This is an independent, third-party profile of Oracle Db Backups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.