Oracle Database Data Guard API

Manage Data Guard associations for high availability

Operations 18

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 #
GET /database/dataguard/databases/{database} Get the current broker configuration database #
GET /database/dataguard/configuration/properties/ Get the current broker configuration properties #
GET /database/dataguard/configuration/properties/{property} Get the specified broker configuration property #
PUT /database/dataguard/configuration/properties/{property} Alter a configuration property #
GET /database/dataguard/databases/{database}/instances/ Get the current broker database instances information #
DELETE /database/dataguard/databases/{database}/instances/{instance} Delete the Data Guard instance #
GET /database/dataguard/databases/{database}/properties/ Get the database Data Guard properties #
GET /database/dataguard/databases/{database}/properties/{property} Get a database Data Guard property #
PUT /database/dataguard/databases/{database}/properties/{property} Set the value of a database Data Guard property #

Documentation

Specifications

Schemas & Data

Other Resources

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: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.

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

OpenAPI Specification

oracle-database-data-guard-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Oracle Database Data Guard API
  x-refined-note:
  - x-refined-note differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Data Guard across 3 of this provider''s published API definitions: oracle-database-oci-openapi.yml, oracle-database-ords-openapi.yml, oracle-database-data-guard-api-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
    get:
      tags:
      - Data Guard
      summary: Get the current broker configuration database
      description: All the broker confguration database. A client requires SQL Administrator role to invoke this service.
      parameters:
      - name: database
        in: path
        description: Database name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information on a specific database in the broker configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataguardConfigurationItemLinks'
      x-internal-id: database-dataguard-databases-{database}-get
      x-filename-id: database-dataguard-databases-database-get
      operationId: getDatabaseDataguardDatabasesByDatabase
      x-operation-id-source: derived
      security:
      - oauth2: []
      - basicAuth: []
  /database/dataguard/configuration/properties/:
    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
    get:
      tags:
      - Data Guard
      summary: Get the current broker configuration properties
      description: All the broker confguration properties. A client requires SQL Administrator role to invoke this service.
      responses:
        '200':
          description: Information on a specific listener and service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataguardConfigurationPropertiesCollection'
      x-internal-id: database-dataguard-configuration-properties--get
      x-filename-id: database-dataguard-configuration-properties-get
      operationId: getDatabaseDataguardConfigurationProperties
      x-operation-id-source: derived
  /database/dataguard/configuration/properties/{property}:
    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
    get:
      tags:
      - Data Guard
      summary: Get the specified broker configuration property
      description: Get the specified configuration property. A client requires SQL Administrator role to invoke this service.
      parameters:
      - name: property
        in: path
        description: Name of the property
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The property value
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataguardConfigurationPropertyItem'
      x-internal-id: database-dataguard-configuration-properties-{property}-get
      x-filename-id: database-dataguard-configuration-properties-property-get
      operationId: getDatabaseDataguardConfigurationPropertiesByProperty
      x-operation-id-source: derived
    put:
      tags:
      - Data Guard
      summary: Alter a configuration property
      description: Alter a configuration property. A client requires SQL Administrator role to invoke this service.
      parameters:
      - name: property
        in: path
        description: Name of the property
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                value:
                  type: string
                  description: Value of the property
            examples:
              enable_configuration:
                summary: Alter a configuration property
                value:
                  value: USER
      responses:
        '201':
          description: Data Guard status
          headers:
            DG-STATUS:
              schema:
                type: string
              description: Status of the Data Guard operation.
        '400':
          description: Data Guard Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
          headers:
            DG-STATUS:
              schema:
                type: string
              description: Status of the Data Guard operation.
      x-internal-id: database-dataguard-configuration-properties-{property}-put
      x-filename-id: database-dataguard-configuration-properties-property-put
      operationId: putDatabaseDataguardConfigurationPropertiesByProperty
      x-operation-id-source: derived
  /database/dataguard/databases/{database}/instances/:
    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
    get:
      tags:
      - Data Guard
      summary: Get the current broker database instances information
      description: All the broker databases. A client requires SQL Administrator role to invoke this service.
      parameters:
      - name: database
        in: path
        description: Database Name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information of all database instances.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataguardInstanceCollection'
      x-internal-id: database-dataguard-databases-{database}-instances--get
      x-filename-id: database-dataguard-databases-database-instances-get
      operationId: getDatabaseDataguardDatabasesByDatabaseInstances
      x-operation-id-source: derived
  /database/dataguard/databases/{database}/instances/{instance}:
    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
    delete:
      tags:
      - Data Guard
      summary: Delete the Data Guard instance
      description: Delete a Data Guard instance. A client requires SQL Administrator role to invoke this service.
      parameters:
      - name: database
        in: path
        description: Database Name
        required: true
        schema:
          type: string
      - name: instance
        in: path
        description: Instance name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Data Guard status
          headers:
            DG-STATUS:
              schema:
                type: string
              description: Status of the Data Guard operation.
        '400':
          description: Data Guard Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
          headers:
            DG-STATUS:
              schema:
                type: string
              description: Status of the Data Guard operation.
      x-internal-id: database-dataguard-databases-{database}-instances-{instance}-delete
      x-filename-id: database-dataguard-databases-database-instances-instance-delete
      operationId: deleteDatabaseDataguardDatabasesByDatabaseInstancesByInstance
      x-operation-id-source: derived
  /database/dataguard/databases/{database}/properties/:
    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
    get:
      tags:
      - Data Guard
      summary: Get the database Data Guard properties
      description: Get database Data Guard properties. A client requires SQL Administrator role to invoke this service.
      parameters:
      - name: database
        in: path
        description: Database Name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information on a specific database Data Guard properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataguardConfigurationPropertiesCollection'
      x-internal-id: database-dataguard-databases-{database}-properties--get
      x-filename-id: database-dataguard-databases-database-properties-get
      operationId: getDatabaseDataguardDatabasesByDatabaseProperties
      x-operation-id-source: derived
  /database/dataguard/databases/{database}/properties/{property}:
    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
    get:
      tags:
      - Data Guard
      summary: Get a database Data Guard property
      description: Get a database Data Guard property. A client requires SQL Administrator role to invoke this service.
      parameters:
      - name: database
        in: path
        description: Database Name
        required: true
        schema:
          type: string
      - name: property
        in: path
        description: Property Name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information on a specific Data Guard property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataguardConfigurationPropertyItem'
      x-internal-id: database-dataguard-databases-{database}-properties-{property}-get
      x-filename-id: database-dataguard-databases-database-properties-property-get
      operationId: getDatabaseDataguardDatabasesByDatabasePropertiesByProperty
      x-operation-id-source: derived
    put:
      tags:
      - Data Guard
      summary: Set the value of a database Data Guard property
      description: Sets the value of a database Data Guard property. A client requires SQL Administrator role to invoke this service.
      parameters:
      - name: database
        in: path
        description: Database Name
        required: true
        schema:
          type: string
      - name: property
        in: path
        description: Property Nane
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                value:
                  type: string
                  description: Value of the property to set
                  default: ''
            examples:
              set_value:
                summary: Sets a Value
                value:
                  value: '2'
      responses:
        '201':
          description: Data Guard status
          headers:
            DG-STATUS:
              schema:
                type: string
              description: Status of the Data Guard operation.
        '400':
          description: Data Guard Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
          headers:
            DG-STATUS:
              schema:
                type: string
              description: Status of the Data Guard operation.
      x-internal-id: database-dataguard-databases-{database}-properties-{property}-put
      x-filename-id: database-dataguard-databases-database-properties-property-put
      operationId: putDatabaseDataguardDatabasesByDatabasePropertiesByProperty
      x-operation-id-source: derived
components:
  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'
    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'
  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
    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
    DataGuardConfiguration:
      type: object
      properties:
        configuration_name:
          type: string
        protection_mode:
          type: string
        enabled:
          type: boolean
        databases:
          type: array
          items:
            $ref: '#/components/schemas/DataGuardDatabase'
    UpdateDataGuardDatabaseRequest:
      type: object
      properties:
        action:
          type: string
          enum:
          - ENABLE
          - DISABLE
          - CONVERT
          - SWITCHOVER
          - FAILOVER
    DataGuardDatabaseList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DataGuardDatabase'
    Error_2:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        type:
          type: string
    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
    AddDataGuardDatabaseRequest:
      type: object
      required:
      - database_name
      - connect_identifier
      properties:
        database_name:
          type: string
        connect_identifier:
          type: string
    DataguardInstanceCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DataguardInstanceItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DataguardConfigurationItemLinks:
      type: object
      properties:
        inst_id:
          type: integer
        database:
          type: string
        connection_identifier:
          type: string
        dataguard_role:
          type: string
        redo_source:
          type: string
        enabled:
          type: string
        status:
          type: integer
        severity:
          type: string
        status_message:
          type: string
        version:
          type: string
        con_id:
          type: integer
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    LinkRelation:
      type: object
      properties:
        rel:
          type: string
        href:
          type: string
      required:
      - rel
      - href
    DataguardConfigurationPropertyItem:
      type: object
      properties:
        property:
          type: string
        property_type:
          type: string
        value:
          type: string
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DataguardConfigurationPropertiesCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DataguardConfigurationPropertyItem'
        hasMore:
          type: boolean
          description: Indicates if there are more records to be retrieved.
        limit:
          type: integer
          description: The actual page size limit on number of records applied by the server.
        offset:
          type: integer
          description: The actual index from which the item resources are returned.
        count:
          type: integer
          description: Total number of records in the current response.
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkRelation'
    DataguardInstanceItem:
      type: object
      properties:
        inst_id:
          type: integer
        instance_number:
          type: integer
        instance_name:
          type: string
        host_name:
          type: string
        version:
          type: string
        version_legacy:
          type: string
        version_full:
          type: string
        startup_time:
          type: string
          format: date-time
        status:
          type: string
        parallel:
          type: string
        thread#:
          type: integer
        archiver:
          type: string
        log_switch_wait:
          type: string
        logins:
          type: string
        shutdown_pending:
          type: string
        database_status:
          type: string
        instance_role:
          type: string
        active_state:
          type: string
        blocked:
          type: string
        con_id:
          type: integer
        instance_mode:
          type: string
        edition:
          type: string
        family:
          type: string
        database_type:
          type: string
    ErrorObject:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        type:
          type: string
        instance:
          type: string
  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
    BasicAuth:
      type: http
      scheme: basic
    BearerAuth:
      type: http
      scheme: bearer
    OAuth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: /oauth/auth
          scopes: {}
        authorizationCode:
          authorizationUrl: /oauth/auth
          tokenUrl: /oauth/token
          scopes: {}
        clientCredentials:
          tokenUrl: /oauth/token
          scopes: {}
x-refined-from:
- oracle-database-oci-openapi.yml
- oracle-database-ords-openapi.yml
- oracle-database-data-guard-api-openapi.yml