Oracle

Oracle Db Backups API

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

GitHub OpenAPI

Operations 10

GET /backups List Backups #
POST /backups Create DB System Backup #
POST /backups/actions/copy Copy a DB system backup to another region. #
DELETE /backups/{backupId} Delete a Backup. #
GET /backups/{backupId} Get a Backup. #
PUT /backups/{backupId} Update the Backup metadata. #
POST /backups/{backupId}/actions/cancelDeletion Cancel the scheduled deletion of a backup. #
POST /backups/{backupId}/actions/changeCompartment Move a DB System Backup from one compartment to another. #
POST /backups/{backupId}/actions/export Export a DB system backup to an Object Storage bucket. #
POST /backups/{backupId}/actions/validate Request to validate the backup by checking the data consistency. #

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-dbbackups-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/oracle-dbbackups-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

oracle-dbbackups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: The API for the MySQL Database Service
  license:
    name: Oracle Corporation
  title: MySQL Database Service Db Backups API
  version: '20190415'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/c21bc5da8ceddf436da4e56b2328b97fa65fa6675d07108e7a0447de3e832a0a.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the MySQL Database Service API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/c21bc5da8ceddf436da4e56b2328b97fa65fa6675d07108e7a0447de3e832a0a.yaml
    what: the harvested document for MySQL Database Service API
servers:
- url: http://mysql.{region}.ocp.oraclecloud.com/20190415
tags:
- name: dbBackups
paths:
  /backups:
    get:
      description: 'Get a list of DB System backups.

        '
      operationId: ListBackups
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/FilterByBackupIdQueryParam'
      - $ref: '#/components/parameters/FilterByBackupLifecycleStateQueryParam'
      - $ref: '#/components/parameters/FilterByCompartmentIdQueryParam'
      - $ref: '#/components/parameters/FilterByDbSystemIdQueryParam'
      - $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
      - $ref: '#/components/parameters/FilterByBackupSoftDeleteQueryParam'
      - $ref: '#/components/parameters/FilterByBackupPreparationStatusQueryParam'
      - $ref: '#/components/parameters/FilterByValidationStatusQueryParam'
      - $ref: '#/components/parameters/FilterByBackupCreationTypeQueryParam'
      - $ref: '#/components/parameters/SortByBackupFieldQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      responses:
        200:
          description: All Backups.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/BackupSummary'
                type: array
        400:
          $ref: '#/components/responses/400-BadRequest'
        401:
          $ref: '#/components/responses/401-Unauthorized'
        404:
          $ref: '#/components/responses/404-NotFound'
        429:
          $ref: '#/components/responses/429-TooManyRequests'
        500:
          $ref: '#/components/responses/500-ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: List Backups
      tags:
      - dbBackups
      x-obmcs-client-retries-enabled: true
    post:
      description: 'Create a backup of a DB System.

        '
      operationId: CreateBackup
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/OpcRetryTokenHeader'
      responses:
        201:
          description: 'The DB System backup action has been Created, but might not yet be Available for use.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Backup'
        400:
          $ref: '#/components/responses/400-BadRequest'
        401:
          $ref: '#/components/responses/401-Unauthorized'
        404:
          $ref: '#/components/responses/404-NotFound'
        409:
          $ref: '#/components/responses/409-Conflict'
        412:
          $ref: '#/components/responses/412-PreconditionFailed'
        429:
          $ref: '#/components/responses/429-TooManyRequests'
        500:
          $ref: '#/components/responses/500-ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Create DB System Backup
      tags:
      - dbBackups
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Backup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBackupDetails'
        description: Create a Backup of a DB System.
        required: true
  /backups/actions/copy:
    post:
      description: 'Creates a copy of a DB system backup available in the specified source region.

        '
      operationId: CopyBackup
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/OpcRetryTokenHeader'
      responses:
        202:
          description: The request was successfully received and the DB system backup is being copied.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Backup'
        400:
          $ref: '#/components/responses/400-BadRequest'
        401:
          $ref: '#/components/responses/401-Unauthorized'
        404:
          $ref: '#/components/responses/404-NotFound'
        409:
          $ref: '#/components/responses/409-Conflict'
        412:
          $ref: '#/components/responses/412-PreconditionFailed'
        429:
          $ref: '#/components/responses/429-TooManyRequests'
        500:
          $ref: '#/components/responses/500-ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Copy a DB system backup to another region.
      tags:
      - dbBackups
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Backup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopyBackupDetails'
        description: Details required to copy a given DB system backup to another region.
        required: true
  /backups/{backupId}:
    delete:
      description: 'Delete a Backup.

        '
      operationId: DeleteBackup
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/BackupIdPathParam'
      responses:
        204:
          description: The request to delete the resource was successful.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400-BadRequest'
        401:
          $ref: '#/components/responses/401-Unauthorized'
        404:
          $ref: '#/components/responses/404-NotFound'
        412:
          $ref: '#/components/responses/412-PreconditionFailed'
        429:
          $ref: '#/components/responses/429-TooManyRequests'
        500:
          $ref: '#/components/responses/500-ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a Backup.
      tags:
      - dbBackups
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Backup'
    get:
      description: Get information about the specified Backup
      operationId: GetBackup
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/IfNoneMatchHeader'
      - $ref: '#/components/parameters/BackupIdPathParam'
      responses:
        200:
          description: The requested Backup.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Backup'
        304:
          $ref: '#/components/responses/304-NotModified'
        400:
          $ref: '#/components/responses/400-BadRequest'
        401:
          $ref: '#/components/responses/401-Unauthorized'
        404:
          $ref: '#/components/responses/404-NotFound'
        429:
          $ref: '#/components/responses/429-TooManyRequests'
        500:
          $ref: '#/components/responses/500-ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Get a Backup.
      tags:
      - dbBackups
      x-obmcs-client-retries-enabled: true
    put:
      description: Update the metadata of a Backup. Metadata such as the displayName or description
      operationId: UpdateBackup
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/BackupIdPathParam'
      responses:
        200:
          description: The Backup metadata was updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Backup'
        304:
          $ref: '#/components/responses/304-NotModified'
        400:
          $ref: '#/components/responses/400-BadRequest'
        401:
          $ref: '#/components/responses/401-Unauthorized'
        404:
          $ref: '#/components/responses/404-NotFound'
        412:
          $ref: '#/components/responses/412-PreconditionFailed'
        429:
          $ref: '#/components/responses/429-TooManyRequests'
        500:
          $ref: '#/components/responses/500-ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Update the Backup metadata.
      tags:
      - dbBackups
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Backup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBackupDetails'
        description: Request to update a Backup's metadata.
        required: true
  /backups/{backupId}/actions/cancelDeletion:
    post:
      description: 'Cancels the scheduled deletion of a backup and moves it to ACTIVE state.

        '
      operationId: CancelBackupDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/OpcRetryTokenHeader'
      - $ref: '#/components/parameters/BackupIdPathParam'
      responses:
        204:
          description: The request to cancel scheduled deletion of a backup is successful.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400-BadRequest'
        401:
          $ref: '#/components/responses/401-Unauthorized'
        404:
          $ref: '#/components/responses/404-NotFound'
        409:
          $ref: '#/components/responses/409-Conflict'
        412:
          $ref: '#/components/responses/412-PreconditionFailed'
        429:
          $ref: '#/components/responses/429-TooManyRequests'
        500:
          $ref: '#/components/responses/500-ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Cancel the scheduled deletion of a backup.
      tags:
      - dbBackups
      x-obmcs-client-retries-enabled: true
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/Backup'
  /backups/{backupId}/actions/changeCompartment:
    post:
      description: 'Moves a DB System Backup into a different compartment.

        When provided, If-Match is checked against ETag values of the Backup.

        '
      operationId: ChangeBackupCompartment
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/OpcRetryTokenHeader'
      - $ref: '#/components/parameters/BackupIdPathParam'
      responses:
        204:
          description: DB System Backup compartment has been changed.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400-BadRequest'
        401:
          $ref: '#/components/responses/401-Unauthorized'
        404:
          $ref: '#/components/responses/404-NotFound'
        409:
          $ref: '#/components/responses/409-Conflict'
        412:
          $ref: '#/components/responses/412-PreconditionFailed'
        429:
          $ref: '#/components/responses/429-TooManyRequests'
        500:
          $ref: '#/components/responses/500-ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Move a DB System Backup from one compartment to another.
      tags:
      - dbBackups
      x-related-resource: '#/definitions/Backup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeBackupCompartmentDetails'
        description: Target compartment for a DB System Backup.
        required: true
  /backups/{backupId}/actions/export:
    post:
      description: 'Export logical data from a DB system backup to an Object Storage bucket.

        '
      operationId: ExportBackup
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/OpcRetryTokenHeader'
      - $ref: '#/components/parameters/BackupIdPathParam'
      responses:
        202:
          description: The request was successfully received and the DB system backup is being exported.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400-BadRequest'
        401:
          $ref: '#/components/responses/401-Unauthorized'
        404:
          $ref: '#/components/responses/404-NotFound'
        409:
          $ref: '#/components/responses/409-Conflict'
        412:
          $ref: '#/components/responses/412-PreconditionFailed'
        429:
          $ref: '#/components/responses/429-TooManyRequests'
        500:
          $ref: '#/components/responses/500-ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Export a DB system backup to an Object Storage bucket.
      tags:
      - dbBackups
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Backup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportBackupDetails'
        description: Details required to export a given DB system backup to an Object Storage bucket.
        required: true
  /backups/{backupId}/actions/validate:
    post:
      description: 'Request to validate the backup by checking the data consistency.

        '
      operationId: ValidateBackup
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/OpcRetryTokenHeader'
      - $ref: '#/components/parameters/BackupIdPathParam'
      responses:
        202:
          description: Validate backup request has been successfully triggered.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Backup'
        400:
          $ref: '#/components/responses/400-BadRequest'
        401:
          $ref: '#/components/responses/401-Unauthorized'
        404:
          $ref: '#/components/responses/404-NotFound'
        409:
          $ref: '#/components/responses/409-Conflict'
        412:
          $ref: '#/components/responses/412-PreconditionFailed'
        429:
          $ref: '#/components/responses/429-TooManyRequests'
        500:
          $ref: '#/components/responses/500-ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: 'Request to validate the backup by checking the data consistency.

        '
      tags:
      - dbBackups
      x-obmcs-client-retries-enabled: true
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/Backup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateBackupDetails'
        description: Details required to validate the backup.
components:
  schemas:
    BackupValidationDetails:
      description: Backup validation details.
      properties:
        backupPreparationStatus:
          description: "Indicates whether the backup has been prepared successfully. \nPREPARED: The backup is prepared one.\nNOT_PREPARED: The backup is not prepared.\n"
          enum:
          - PREPARED
          - NOT_PREPARED
          type: string
        errorMessage:
          description: Error message if the backup validation has failed.
          type: string
        estimatedRestoreDuration:
          description: The estimated restore duration of the backup.
          format: x-obmcs-duration
          type: string
        preparedBackupDetails:
          $ref: '#/components/schemas/PreparedBackupDetails'
        timeLastValidated:
          description: The date and time of the most recent validation performed on the backup.
          format: date-time
          type: string
        validationStatus:
          description: "The status of backup validation: \nNOT_VALIDATED (Default): The backup has not been validated. \nVALIDATED: The backup has been validated successfully. \nNEEDS_ATTENTION: The backup validation failed due to a transient issue. Validation should be retried. \nFAILED: The backup cannot be restored.\n"
          enum:
          - NOT_VALIDATED
          - VALIDATED
          - NEEDS_ATTENTION
          - FAILED
          type: string
    DataStorageDetails:
      description: 'Data Storage configuration properties.

        '
      properties:
        isAutoExpandStorageEnabled:
          default: false
          description: 'Enable/disable automatic storage expansion. When set to true, the DB System will automatically

            add storage incrementally up to the value specified in maxStorageSizeInGBs.

            '
          type: boolean
        maxStorageSizeInGBs:
          description: 'Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled

            is set to true, the DB System will add storage incrementally up to this value.


            DB Systems with an initial storage size of 400 GB or less can be expanded up to 32 TB.

            DB Systems with an initial storage size between 401-800 GB can be expanded up to 64 TB.

            DB Systems with an initial storage size between 801-1200 GB can be expanded up to 96 TB.

            DB Systems with an initial storage size of 1201 GB or more can be expanded up to 128 TB.


            It is not possible to decrease data storage size. You cannot set the maximum data storage size to less

            than either current DB System dataStorageSizeInGBs or allocatedStorageSizeInGBs.

            '
          maximum: 131072
          minimum: 100
          type: integer
    ReadEndpointDetails:
      description: 'The read endpoint of a DB System.

        '
      properties:
        excludeIps:
          description: 'A list of IP addresses of read replicas that are excluded from serving read requests.

            '
          items:
            type: string
          type: array
        isEnabled:
          default: false
          description: 'Specifies if the DB System read endpoint is enabled or not.

            '
          type: boolean
        readEndpointHostnameLabel:
          description: 'The hostname for the read endpoint of the DB System. Used for DNS.


            The value is the hostname portion of the primary private IP''s fully qualified domain name (FQDN)

            (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com").


            Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

            '
          type: string
        readEndpointIpAddress:
          description: 'The IP address the DB System read endpoint is configured to listen on.

            A private IP address of your choice to assign to the read endpoint of the DB System.

            Must be an available IP address within the subnet''s CIDR. If you don''t specify a value,

            Oracle automatically assigns a private IP address from the subnet. This should be a

            "dotted-quad" style IPv4 address.

            '
          type: string
          x-default-description: 'If you don''t specify a value, Oracle automatically assigns a private IPv4 address from the subnet.

            '
        readEndpointIpv6AddressIpv6SubnetCidrPairDetails:
          $ref: '#/components/schemas/Ipv6AddressIpv6SubnetCidrPairDetails'
    UpdateBackupDetails:
      description: 'The Backup metadata which can be updated.

        '
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: A user-supplied description for the backup.
          maxLength: 400
          minLength: 1
          type: string
        displayName:
          description: A user-supplied display name for the backup.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        retentionInDays:
          description: 'The number of days backups are retained.

            '
          maximum: 365
          minimum: 1
          type: integer
        softDelete:
          description: 'Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED

            state for 7 days before permanently deleting it.

            '
          enum:
          - ENABLED
          - DISABLED
          type: string
          x-obmcs-top-level-enum: '#/definitions/SoftDelete'
    DestinationConfiguration:
      description: Configuration variable of a given destination.
      properties:
        key:
          description: Name of the destination configuration variable.
          maxLength: 255
          minLength: 1
          type: string
        value:
          description: Value of the destination configuration variable.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - key
      - value
      type: object
    PreparedBackupDetails:
      description: Prepared backup details.
      properties:
        preparedBackupRestoreReductionInMinutes:
          description: The estimated time saving when this prepared backup is restored.
          type: integer
        timePrepared:
          description: The date and time the backup was prepared.
          format: date-time
          type: string
    DbSystemSnapshot:
      description: 'Snapshot of the DbSystem details at the time of the backup

        '
      properties:
        adminUsername:
          description: The username for the administrative user.
          maxLength: 32
          minLength: 1
          type: string
        availabilityDomain:
          description: 'The Availability Domain where the primary DB System should be located.

            '
          maxLength: 255
          minLength: 1
          type: string
        backupPolicy:
          $ref: '#/components/schemas/BackupPolicy'
        compartmentId:
          description: The OCID of the compartment the DB System belongs in.
          maxLength: 255
          minLength: 1
          type: string
        configurationId:
          description: The OCID of the Configuration to be used for Instances in this DB System.
          maxLength: 255
          minLength: 1
          type: string
        crashRecovery:
          default: ENABLED
          description: 'Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled,

            and whether to enable or disable syncing of the Binary Logs.

            '
          enum:
          - ENABLED
          - DISABLED
          type: string
          x-obmcs-top-level-enum: '#/definitions/CrashRecoveryStatus'
        dataStorage:
          $ref: '#/components/schemas/DataStorage'
        dataStorageSizeInGBs:
          description: 'DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs.

            Replaced by dataStorage.dataStorageSizeInGBs.

            '
          maximum: 131072
          minimum: 50
          type: integer
        databaseConsole:
          $ref: '#/components/schemas/DatabaseConsoleDetails'
        databaseManagement:
          default: ENABLED
          description: 'Whether to enable monitoring via the Database Management service.

            '
          enum:
          - ENABLED
          - DISABLED
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatabaseManagementStatus'
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        deletionPolicy:
          $ref: '#/components/schemas/DeletionPolicyDetails'
        description:
          description: User-provided data about the DB System.
          maxLength: 400
          minLength: 1
          type: string
        displayName:
          description: The user-friendly name for the DB System. It does not have to be unique.
          maxLength: 255
          minLength: 1
          type: string
        encryptData:
          $ref: '#/components/schemas/EncryptDataDetails'
        endpoints:
          description: 'The network endpoints available for this DB System.

            '
          items:
            $ref: '#/components/schemas/DbSystemEndpoint'
          type: array
        faultDomain:
       

# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-dbbackups-api-openapi.yml