Oracle

Oracle Db Backups API

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

GitHub OpenAPI

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

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:
    BackupPolicy:
      description: The Backup policy for the DB System.
      properties:
        copyPolicies:
          description: 'List of policies of a DB system to schedule cross-region DB system backup copy.


            The policy includes the name of the destination region to which the DB system backup will be copied, and

            an optional parameter which specifies the retention period of the copied DB system backup in days.


            **Note:** Currently, only one policy can be specified in the list.

            '
          items:
            $ref: '#/components/schemas/CopyPolicy'
          type: array
        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: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.


            Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.


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

            '
          type: object
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.


            Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.


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

            '
          type: object
        isEnabled:
          default: true
          description: If automated backups are enabled or disabled.
          type: boolean
        pitrPolicy:
          $ref: '#/components/schemas/PitrPolicy'
        retentionInDays:
          description: 'The number of days automated backups are retained.

            '
          maximum: 35
          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'
        windowStartTime:
          description: 'The start of a 30-minute window of time in which daily, automated backups occur.


            This should be in the format of the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.


            At some point in the window, the system may incur a brief service disruption as the backup is performed.


            If not defined, a window is selected from the following Region-based time-spans:

            - eu-frankfurt-1: 20:00 - 04:00 UTC

            - us-ashburn-1: 03:00 - 11:00 UTC

            - uk-london-1: 06:00 - 14:00 UTC

            - ap-tokyo-1: 13:00 - 21:00

            - us-phoenix-1: 06:00 - 14:00

            '
          type: string
      required:
      - isEnabled
      - windowStartTime
      - retentionInDays
    Backup:
      description: '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 authorized in an IAM

        policy. If you''re not authorized, talk to an administrator. If you''re an

        administrator who needs to write policies to give users access, see

        [Getting Started with

        Policies](/Content/Identity/Concepts/policygetstarted.htm).

        '
      properties:
        backupSizeInGBs:
          description: The size of the backup in base-2 (IEC) gibibytes. (GiB).
          type: integer
        backupType:
          description: The type of backup.
          enum:
          - FULL
          - INCREMENTAL
          type: string
        backupValidationDetails:
          $ref: '#/components/schemas/BackupValidationDetails'
        compartmentId:
          description: The OCID of the compartment.
          maxLength: 255
          minLength: 1
          type: string
        creationType:
          description: If the backup was created automatically, or by a manual request.
          enum:
          - MANUAL
          - AUTOMATIC
          type: string
        dataStorageSizeInGBs:
          description: 'Initial size of the data volume in GiBs.

            '
          maximum: 131072
          minimum: 50
          type: integer
        dbSystemId:
          description: The OCID of the DB System the backup is associated with.
          maxLength: 255
          minLength: 1
          type: string
        dbSystemSnapshot:
          $ref: '#/components/schemas/DbSystemSnapshot'
        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
        encryptData:
          $ref: '#/components/schemas/EncryptDataDetails'
        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
        id:
          description: OCID of the backup itself
          maxLength: 255
          minLength: 1
          type: string
        immediateSourceBackupId:
          description: 'The OCID of the immediate source DB system backup from which this DB system backup was copied.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: Additional information about the current lifecycleState.
          type: string
        lifecycleState:
          description: The state of the backup.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - DELETE_SCHEDULED
          type: string
        mysqlVersion:
          description: The MySQL server version of the DB System used for backup.
          type: string
        originalSourceBackupId:
          description: 'The OCID of the original source DB system backup from which this DB system backup was copied.

            '
          maxLength: 255
          minLength: 1
          type: string
        retentionInDays:
          default: 365
          description: Number of days to retain this backup.
          maximum: 365
          minimum: 1
          type: integer
        shapeName:
          description: The shape of the DB System used for backup.
          maxLength: 255
          minLength: 1
          type: string
        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'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCopyCreated:
          description: 'The date and time the DB system backup copy was created, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeCreated:
          description: The time the backup record was created.
          format: date-time
          type: string
        timeUpdated:
          description: The time at which the backup was updated.
          format: date-time
          type: string
      required:
      - id
      - timeCreated
      - timeUpdated
      - lifecycleState
      - lifecycleDetails
      - backupType
      - creationType
      - dbSystemId
      - compartmentId
    DeletionPolicyDetails:
      description: The Deletion policy for the DB System.
      properties:
        automaticBackupRetention:
          default: RETAIN
          description: 'Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.

            '
          enum:
          - DELETE
          - RETAIN
          type: string
        finalBackup:
          default: SKIP_FINAL_BACKUP
          description: "Specifies whether or not a backup is taken when the DB System is deleted.\n  REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted.\n  SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.\n"
          enum:
          - SKIP_FINAL_BACKUP
          - REQUIRE_FINAL_BACKUP
          type: string
        isDeleteProtected:
          default: false
          description: 'Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.

            '
          type: boolean
      required:
      - automaticBackupRetention
      - finalBackup
      - isDeleteProtected
    PreparedBackupDetails:
      description: Prepared backup details.
      properties:
        preparedBackupRes

# --- 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