Oracle Database Data Guard API

openapi: 3.1.0
info:
  title: Oracle Database Oracle Cloud Infrastructure Database APEX Data Guard API
  description: API for managing Oracle Database services in Oracle Cloud Infrastructure (OCI). Provides management of DB Systems, Autonomous Databases, Exadata infrastructure, database backups, Data Guard associations, database homes, and related cloud database resources.
  version: '20160918'
  contact:
    name: Oracle Cloud Support
    url: https://support.oracle.com
    email: cloud-support@oracle.com
  license:
    name: Oracle Cloud Infrastructure Terms
    url: https://www.oracle.com/cloud/free/oci-terms.html
  termsOfService: https://www.oracle.com/legal/terms.html
servers:
- url: https://database.{region}.oraclecloud.com/20160918
  description: OCI Database Service Regional Endpoint
  variables:
    region:
      default: us-ashburn-1
      description: OCI region identifier
      enum:
      - us-ashburn-1
      - us-phoenix-1
      - eu-frankfurt-1
      - uk-london-1
      - ap-tokyo-1
      - ap-mumbai-1
      - ca-toronto-1
      - ap-sydney-1
      - sa-saopaulo-1
      - ap-seoul-1
security:
- ociSignature: []
tags:
- name: Data Guard
  description: Manage Data Guard associations for high availability
paths:
  /dataGuardAssociations:
    get:
      operationId: listDataGuardAssociations
      summary: Oracle Database List Data Guard associations
      description: Returns Data Guard associations for the specified database.
      tags:
      - Data Guard
      parameters:
      - name: databaseId
        in: query
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/pageParam'
      responses:
        '200':
          description: Data Guard associations listed
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataGuardAssociationSummary'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/dataguard/configuration/:
    get:
      operationId: getDataGuardConfiguration
      summary: Oracle Database Get Data Guard broker configuration
      description: Returns the current Data Guard broker configuration.
      tags:
      - Data Guard
      responses:
        '200':
          description: Configuration retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataGuardConfiguration'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
    post:
      operationId: addDataGuardConfiguration
      summary: Oracle Database Add a Data Guard configuration
      description: Creates a new Data Guard broker configuration.
      tags:
      - Data Guard
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataGuardConfigRequest'
      responses:
        '201':
          description: Configuration added successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataGuardConfiguration'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
    put:
      operationId: updateDataGuardConfiguration
      summary: Oracle Database Enable or disable Data Guard configuration
      description: Enables or disables the Data Guard broker configuration.
      tags:
      - Data Guard
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDataGuardConfigRequest'
      responses:
        '200':
          description: Configuration updated successfully
        '401':
          $ref: '#/components/responses/Unauthorized_2'
    delete:
      operationId: removeDataGuardConfiguration
      summary: Oracle Database Remove Data Guard configuration
      description: Removes the Data Guard broker configuration.
      tags:
      - Data Guard
      responses:
        '200':
          description: Configuration removed successfully
        '401':
          $ref: '#/components/responses/Unauthorized_2'
  /database/dataguard/databases/:
    get:
      operationId: getDataGuardDatabases
      summary: Oracle Database Get all Data Guard databases
      description: Returns all databases registered with the Data Guard broker.
      tags:
      - Data Guard
      responses:
        '200':
          description: Databases retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataGuardDatabaseList'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
    post:
      operationId: addDataGuardDatabase
      summary: Oracle Database Add a database to Data Guard
      description: Adds a database to the Data Guard broker configuration.
      tags:
      - Data Guard
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddDataGuardDatabaseRequest'
      responses:
        '201':
          description: Database added successfully
        '401':
          $ref: '#/components/responses/Unauthorized_2'
  /database/dataguard/databases/{database}:
    put:
      operationId: updateDataGuardDatabase
      summary: Oracle Database Update Data Guard database role
      description: Converts, enables, or disables a database in the Data Guard configuration.
      tags:
      - Data Guard
      parameters:
      - name: database
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDataGuardDatabaseRequest'
      responses:
        '200':
          description: Database role updated successfully
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: removeDataGuardDatabase
      summary: Oracle Database Remove database from Data Guard
      description: Removes a database from the Data Guard broker configuration.
      tags:
      - Data Guard
      parameters:
      - name: database
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Database removed successfully
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    UpdateDataGuardDatabaseRequest:
      type: object
      properties:
        action:
          type: string
          enum:
          - ENABLE
          - DISABLE
          - CONVERT
          - SWITCHOVER
          - FAILOVER
    Error_2:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        type:
          type: string
    DataGuardConfiguration:
      type: object
      properties:
        configuration_name:
          type: string
        protection_mode:
          type: string
        enabled:
          type: boolean
        databases:
          type: array
          items:
            $ref: '#/components/schemas/DataGuardDatabase'
    DataGuardDatabaseList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DataGuardDatabase'
    UpdateDataGuardConfigRequest:
      type: object
      properties:
        enabled:
          type: boolean
        protection_mode:
          type: string
    CreateDataGuardConfigRequest:
      type: object
      required:
      - configuration_name
      properties:
        configuration_name:
          type: string
        protection_mode:
          type: string
          enum:
          - MAXIMUM_AVAILABILITY
          - MAXIMUM_PERFORMANCE
          - MAXIMUM_PROTECTION
    DataGuardAssociationSummary:
      type: object
      properties:
        id:
          type: string
        databaseId:
          type: string
        peerDatabaseId:
          type: string
        role:
          type: string
          enum:
          - PRIMARY
          - STANDBY
          - DISABLED_STANDBY
        peerRole:
          type: string
        lifecycleState:
          type: string
        protectionMode:
          type: string
          enum:
          - MAXIMUM_AVAILABILITY
          - MAXIMUM_PERFORMANCE
          - MAXIMUM_PROTECTION
        transportType:
          type: string
          enum:
          - SYNC
          - ASYNC
          - FASTSYNC
        applyLag:
          type: string
        applyRate:
          type: string
        timeCreated:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
    DataGuardDatabase:
      type: object
      properties:
        database_name:
          type: string
        role:
          type: string
          enum:
          - PRIMARY
          - PHYSICAL_STANDBY
          - LOGICAL_STANDBY
          - SNAPSHOT_STANDBY
        enabled:
          type: boolean
        transport_lag:
          type: string
        apply_lag:
          type: string
    AddDataGuardDatabaseRequest:
      type: object
      required:
      - database_name
      - connect_identifier
      properties:
        database_name:
          type: string
        connect_identifier:
          type: string
  parameters:
    limitParam:
      name: limit
      in: query
      description: Maximum number of items to return
      schema:
        type: integer
        minimum: 1
        maximum: 1000
    pageParam:
      name: page
      in: query
      description: Pagination token from a previous response
      schema:
        type: string
  responses:
    Unauthorized_2:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error_2'
    NotFound:
      description: The specified resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error_2'
    Unauthorized:
      description: Not authenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ociSignature:
      type: http
      scheme: bearer
      description: OCI request signature authentication using API signing keys
externalDocs:
  description: OCI Database Service API Documentation
  url: https://docs.oracle.com/iaas/api/#/en/database/20160918/