Oracle Database

Oracle Database Data Guard API

Manage Data Guard associations for high availability

Documentation GitHub OpenAPI

Operations 9

GET /dataGuardAssociations Oracle Database List Data Guard associations #

GET /database/dataguard/configuration/ Oracle Database Get Data Guard broker configuration #

POST /database/dataguard/configuration/ Oracle Database Add a Data Guard configuration #

PUT /database/dataguard/configuration/ Oracle Database Enable or disable Data Guard configuration #

DELETE /database/dataguard/configuration/ Oracle Database Remove Data Guard configuration #

GET /database/dataguard/databases/ Oracle Database Get all Data Guard databases #

POST /database/dataguard/databases/ Oracle Database Add a database to Data Guard #

PUT /database/dataguard/databases/{database} Oracle Database Update Data Guard database role #

DELETE /database/dataguard/databases/{database} Oracle Database Remove database from Data Guard #

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-database-data-guard-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

openapi: 3.2.0
info:
  title: Oracle Database Data Guard API
  termsOfService: https://www.oracle.com/legal/terms.html
  version: '1.0'
  description: 'Operations tagged Data Guard across 2 of this provider''s published API definitions: oracle-database-oci-openapi.yml, oracle-database-ords-openapi.yml. Each path carries the servers of the definition it was published in.'
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
- url: https://{host}:{port}/ords
  description: ORDS Server
  variables:
    host:
      default: localhost
      description: ORDS server hostname
    port:
      default: '8443'
      description: ORDS server port
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'
      security:
      - ociSignature: []
    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
  /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'
      security:
      - oauth2: []
      - basicAuth: []
    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'
      security:
      - oauth2: []
      - basicAuth: []
    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'
      security:
      - oauth2: []
      - basicAuth: []
    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'
      security:
      - oauth2: []
      - basicAuth: []
    servers:
    - url: https://{host}:{port}/ords
      description: ORDS Server
      variables:
        host:
          default: localhost
          description: ORDS server hostname
        port:
          default: '8443'
          description: ORDS server port
  /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'
      security:
      - oauth2: []
      - basicAuth: []
    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'
      security:
      - oauth2: []
      - basicAuth: []
    servers:
    - url: https://{host}:{port}/ords
      description: ORDS Server
      variables:
        host:
          default: localhost
          description: ORDS server hostname
        port:
          default: '8443'
          description: ORDS server port
  /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'
      security:
      - oauth2: []
      - basicAuth: []
    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'
      security:
      - oauth2: []
      - basicAuth: []
    servers:
    - url: https://{host}:{port}/ords
      description: ORDS Server
      variables:
        host:
          default: localhost
          description: ORDS server hostname
        port:
          default: '8443'
          description: ORDS server port
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
    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
    UpdateDataGuardDatabaseRequest:
      type: object
      properties:
        action:
          type: string
          enum:
          - ENABLE
          - DISABLE
          - CONVERT
          - SWITCHOVER
          - FAILOVER
    UpdateDataGuardConfigRequest:
      type: object
      properties:
        enabled:
          type: boolean
        protection_mode:
          type: string
    Error_2:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        type:
          type: string
    AddDataGuardDatabaseRequest:
      type: object
      required:
      - database_name
      - connect_identifier
      properties:
        database_name:
          type: string
        connect_identifier:
          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
    CreateDataGuardConfigRequest:
      type: object
      required:
      - configuration_name
      properties:
        configuration_name:
          type: string
        protection_mode:
          type: string
          enum:
          - MAXIMUM_AVAILABILITY
          - MAXIMUM_PERFORMANCE
          - MAXIMUM_PROTECTION
    DataGuardDatabaseList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DataGuardDatabase'
    DataGuardConfiguration:
      type: object
      properties:
        configuration_name:
          type: string
        protection_mode:
          type: string
        enabled:
          type: boolean
        databases:
          type: array
          items:
            $ref: '#/components/schemas/DataGuardDatabase'
  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:
      description: Not authenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The specified resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error_2'
    Unauthorized_2:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error_2'
  securitySchemes:
    ociSignature:
      type: http
      scheme: bearer
      description: OCI request signature authentication using API signing keys
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /ords/{schema}/oauth/token
          scopes: {}
        authorizationCode:
          authorizationUrl: /ords/{schema}/oauth/auth
          tokenUrl: /ords/{schema}/oauth/token
          scopes: {}
    basicAuth:
      type: http
      scheme: basic
x-refined-from:
- oracle-database-oci-openapi.yml
- oracle-database-ords-openapi.yml

Oracle Database Data Guard API

Operations 9

Documentation

Specifications

Schemas & Data

Other Resources