Oracle GoldenGate

Oracle GoldenGate Connections API

Manage database and service connections

Documentation GitHub OpenAPI

Operations 21

GET /20200407/connections Oracle Goldengate List Connections #

POST /20200407/connections Oracle Goldengate Create a Connection #

GET /20200407/connections/{connectionId} Oracle Goldengate Get a Connection #

PUT /20200407/connections/{connectionId} Oracle Goldengate Update a Connection #

DELETE /20200407/connections/{connectionId} Oracle Goldengate Delete a Connection #

GET /services/v2/connections Oracle Goldengate List Database Connections #

GET /services/v2/connections/{connection} Oracle Goldengate Retrieve a Database Connection #

POST /services/v2/connections/{connection} Oracle Goldengate Create a Database Connection #

PUT /services/v2/connections/{connection} Oracle Goldengate Replace a Database Connection #

DELETE /services/v2/connections/{connection} Oracle Goldengate Delete a Database Connection #

POST /services/v2/connections/{connection}/trandata/table Oracle Goldengate Manage Table Supplemental Logging #

POST /services/v2/connections/{connection}/trandata/schema Oracle Goldengate Manage Schema Supplemental Logging #

GET /services/v2/connections/{connection}/databases Oracle Goldengate Retrieve Database Names #

GET /services/v2/connections/{connection}/databases/{database}/{schema} Oracle Goldengate Retrieve Database Tables #

GET /services/configuration/connections Oracle Goldengate Retrieve All Connections #

POST /services/configuration/connections Oracle Goldengate Create a Connection #

GET /services/configuration/connections/{Id} Oracle Goldengate Retrieve a Connection #

PATCH /services/configuration/connections/{Id} Oracle Goldengate Update a Connection #

DELETE /services/configuration/connections/{Id} Oracle Goldengate Delete a Connection #

GET /services/configuration/connections/{Id}/status Oracle Goldengate Retrieve Connection Status #

POST /services/configuration/connections/{Id}/metadata Oracle Goldengate Retrieve Connection Metadata #

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-goldengate-connections-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 Goldengate Connections API
  contact:
    name: Oracle Support
    url: https://support.oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/legal/terms.html
  x-refined-note:
  - x-documentation differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Connections across 3 of this provider''s published API definitions: oracle-goldengate-cloud-service-api-openapi.yml, oracle-goldengate-rest-api-openapi.yml, oracle-goldengate-veridata-rest-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://goldengate.{region}.oci.oraclecloud.com
  description: OCI GoldenGate 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-sydney-1
      - ca-toronto-1
      - ap-mumbai-1
      - sa-saopaulo-1
- url: https://{goldengate-host}:{port}
  description: Oracle GoldenGate Microservices server
  variables:
    goldengate-host:
      default: localhost
      description: GoldenGate Microservices host
    port:
      default: '443'
      description: HTTPS port for the service
- url: https://{veridata-host}:{port}/veridata/v1
  description: Oracle GoldenGate Veridata server
  variables:
    veridata-host:
      default: localhost
      description: Veridata server host
    port:
      default: '8830'
      description: Veridata HTTPS port
tags:
- name: Connections
  description: Manage database and service connections
paths:
  /20200407/connections:
    get:
      operationId: listConnections
      summary: Oracle Goldengate List Connections
      description: Returns a list of connections in the specified compartment.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/compartmentIdParam'
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/pageParam'
      - name: connectionType
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - GOLDENGATE
            - KAFKA
            - KAFKA_SCHEMA_REGISTRY
            - MYSQL
            - POSTGRESQL
            - ORACLE
            - MICROSOFT_SQLSERVER
            - MONGODB
            - ELASTICSEARCH
            - AMAZON_S3
            - AMAZON_KINESIS
            - AZURE_DATA_LAKE_STORAGE
            - AZURE_SYNAPSE_ANALYTICS
            - GOOGLE_BIGQUERY
            - GOOGLE_CLOUD_STORAGE
            - HDFS
            - OCI_OBJECT_STORAGE
            - REDIS
            - SNOWFLAKE
            - JAVA_MESSAGE_SERVICE
            - DB2
            - GENERIC
        example: []
      responses:
        '200':
          description: Connections listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionCollection'
              examples:
                Listconnections200Example:
                  summary: Default listConnections 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - id: abc123
                      displayName: example_value
                      connectionType: example_value
                      lifecycleState: example_value
                      timeCreated: '2026-01-15T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - ociSignature: []
    post:
      operationId: createConnection
      summary: Oracle Goldengate Create a Connection
      description: Creates a new connection for a source or target system. Supports Oracle, MySQL, PostgreSQL, SQL Server, MongoDB, Kafka, Elasticsearch, Amazon S3, Google BigQuery, Snowflake, and many other connection types.
      tags:
      - Connections
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectionDetails'
            examples:
              CreateconnectionRequestExample:
                summary: Default createConnection request
                x-microcks-default: true
                value:
                  displayName: example_value
                  description: A sample description.
                  compartmentId: '500123'
                  connectionType: example_value
                  technologyType: example_value
                  freeformTags: example_value
      responses:
        '200':
          description: Connection creation initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
              examples:
                Createconnection200Example:
                  summary: Default createConnection 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    displayName: example_value
                    description: A sample description.
                    compartmentId: '500123'
                    connectionType: GOLDENGATE
                    technologyType: example_value
                    lifecycleState: example_value
                    timeCreated: '2026-01-15T10:30:00Z'
                    timeUpdated: '2026-01-15T10:30:00Z'
                    freeformTags: example_value
          headers:
            opc-work-request-id:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/BadRequest'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - ociSignature: []
    servers:
    - url: https://goldengate.{region}.oci.oraclecloud.com
      description: OCI GoldenGate 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-sydney-1
          - ca-toronto-1
          - ap-mumbai-1
          - sa-saopaulo-1
  /20200407/connections/{connectionId}:
    get:
      operationId: getConnection
      summary: Oracle Goldengate Get a Connection
      description: Returns the details of a specific connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam'
      responses:
        '200':
          description: Connection retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
              examples:
                Getconnection200Example:
                  summary: Default getConnection 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    displayName: example_value
                    description: A sample description.
                    compartmentId: '500123'
                    connectionType: GOLDENGATE
                    technologyType: example_value
                    lifecycleState: example_value
                    timeCreated: '2026-01-15T10:30:00Z'
                    timeUpdated: '2026-01-15T10:30:00Z'
                    freeformTags: example_value
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - ociSignature: []
    put:
      operationId: updateConnection
      summary: Oracle Goldengate Update a Connection
      description: Updates a connection's configuration.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam'
      - $ref: '#/components/parameters/ifMatchParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectionDetails'
            examples:
              UpdateconnectionRequestExample:
                summary: Default updateConnection request
                x-microcks-default: true
                value:
                  displayName: example_value
                  description: A sample description.
                  freeformTags: example_value
      responses:
        '200':
          description: Update initiated
          headers:
            opc-work-request-id:
              schema:
                type: string
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - ociSignature: []
    delete:
      operationId: deleteConnection
      summary: Oracle Goldengate Delete a Connection
      description: Deletes a connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam'
      - $ref: '#/components/parameters/ifMatchParam'
      responses:
        '202':
          description: Deletion accepted
          headers:
            opc-work-request-id:
              schema:
                type: string
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - ociSignature: []
    servers:
    - url: https://goldengate.{region}.oci.oraclecloud.com
      description: OCI GoldenGate 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-sydney-1
          - ca-toronto-1
          - ap-mumbai-1
          - sa-saopaulo-1
  /services/v2/connections:
    get:
      operationId: listConnections
      summary: Oracle Goldengate List Database Connections
      description: Returns a list of all configured database connections.
      tags:
      - Connections
      responses:
        '200':
          description: Connections listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionList'
              examples:
                Listconnections200Example:
                  summary: Default listConnections 200 response
                  x-microcks-default: true
                  value:
                    connections:
                    - name: Example Title
                      type: example_value
                      connectionString: example_value
                      credentials: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/connections/{connection}:
    get:
      operationId: getConnection
      summary: Oracle Goldengate Retrieve a Database Connection
      description: Returns details of a specific database connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionParam'
      responses:
        '200':
          description: Connection details retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseConnection'
              examples:
                Getconnection200Example:
                  summary: Default getConnection 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    type: example_value
                    connectionString: example_value
                    credentials:
                      domain: example_value
                      alias: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    post:
      operationId: createConnection
      summary: Oracle Goldengate Create a Database Connection
      description: Creates a new database connection with the specified credentials and connection string.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectionRequest'
            examples:
              CreateconnectionRequestExample:
                summary: Default createConnection request
                x-microcks-default: true
                value:
                  type: example_value
                  connectionString: example_value
                  credentials:
                    domain: example_value
                    alias: example_value
      responses:
        '201':
          description: Connection created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseConnection'
              examples:
                Createconnection201Example:
                  summary: Default createConnection 201 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    type: example_value
                    connectionString: example_value
                    credentials:
                      domain: example_value
                      alias: example_value
        '400':
          $ref: '#/components/responses/BadRequest_2'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    put:
      operationId: replaceConnection
      summary: Oracle Goldengate Replace a Database Connection
      description: Replaces the configuration of an existing database connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectionRequest'
            examples:
              ReplaceconnectionRequestExample:
                summary: Default replaceConnection request
                x-microcks-default: true
                value:
                  type: example_value
                  connectionString: example_value
                  credentials:
                    domain: example_value
                    alias: example_value
      responses:
        '200':
          description: Connection replaced
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseConnection'
              examples:
                Replaceconnection200Example:
                  summary: Default replaceConnection 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    type: example_value
                    connectionString: example_value
                    credentials:
                      domain: example_value
                      alias: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    delete:
      operationId: deleteConnection
      summary: Oracle Goldengate Delete a Database Connection
      description: Deletes a database connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionParam'
      responses:
        '204':
          description: Connection deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/connections/{connection}/trandata/table:
    post:
      operationId: manageTableSupplementalLogging
      summary: Oracle Goldengate Manage Table Supplemental Logging
      description: Adds or removes supplemental logging for a specific table to enable change data capture.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrandataRequest'
            examples:
              ManagetablesupplementalloggingRequestExample:
                summary: Default manageTableSupplementalLogging request
                x-microcks-default: true
                value:
                  operation: add
                  name: Example Title
      responses:
        '200':
          description: Supplemental logging managed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrandataResponse'
              examples:
                Managetablesupplementallogging200Example:
                  summary: Default manageTableSupplementalLogging 200 response
                  x-microcks-default: true
                  value:
                    result: example_value
                    message: example_value
        '400':
          $ref: '#/components/responses/BadRequest_2'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/connections/{connection}/trandata/schema:
    post:
      operationId: manageSchemaSupplementalLogging
      summary: Oracle Goldengate Manage Schema Supplemental Logging
      description: Adds or removes supplemental logging for all tables in a schema.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrandataRequest'
            examples:
              ManageschemasupplementalloggingRequestExample:
                summary: Default manageSchemaSupplementalLogging request
                x-microcks-default: true
                value:
                  operation: add
                  name: Example Title
      responses:
        '200':
          description: Schema supplemental logging managed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrandataResponse'
              examples:
                Manageschemasupplementallogging200Example:
                  summary: Default manageSchemaSupplementalLogging 200 response
                  x-microcks-default: true
                  value:
                    result: example_value
                    message: example_value
        '400':
          $ref: '#/components/responses/BadRequest_2'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/connections/{connection}/databases:
    get:
      operationId: getDatabaseNames
      summary: Oracle Goldengate Retrieve Database Names
      description: Returns available database names for a connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionParam'
      responses:
        '200':
          description: Database names retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseNameList'
              examples:
                Getdatabasenames200Example:
                  summary: Default getDatabaseNames 200 response
                  x-microcks-default: true
                  value:
                    databases:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/connections/{connection}/databases/{database}/{schema}:
    get:
      operationId: getDatabaseTables
      summary: Oracle Goldengate Retrieve Database Tables
      description: Returns a list of tables in a specific database schema.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionParam'
      - name: database
        in: path
        required: true
        schema:
          type: string
        example: example_value
      - name: schema
        in: path
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Tables retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableList'
              examples:
                Getdatabasetables200Example:
                  summary: Default getDatabaseTables 200 response
                  x-microcks-default: true
                  value:
                    tables:
                    - name: Example Title
                      owner: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/configuration/connections:
    get:
      operationId: listConnections
      summary: Oracle Goldengate Retrieve All Connections
      description: Returns a list of all configured source and target database connections.
      tags:
      - Connections
      responses:
        '200':
          description: Connections listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionList_2'
              examples:
                Listconnections200Example:
                  summary: Default listConnections 200 response
                  x-microcks-default: true
                  value:
                    connections:
                    - id: abc123
                      name: Example Title
                      description: A sample description.
                      databaseType: Oracle
                      host: example_value
                      port: 10
                      serviceName: example_value
                      schema: example_value
                      agentHost: example_value
                      agentPort: 10
        '401':
          $ref: '#/components/responses/Unauthorized_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    post:
      operationId: createConnection
      summary: Oracle Goldengate Create a Connection
      description: Creates a new database connection for use as a source or target in comparisons.
      tags:
      - Connections
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectionRequest_2'
            examples:
              CreateconnectionRequestExample:
                summary: Default createConnection request
                x-microcks-default: true
                value:
                  name: Example Title
                  description: A sample description.
                  databaseType: example_value
                  host: example_value
                  port: 10
                  serviceName: example_value
                  schema: example_value
                  username: example_value
                  password: example_value
                  agentHost: example_value
                  agentPort: 10
      responses:
        '201':
          description: Connection created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection_2'
              examples:
                Createconnection201Example:
                  summary: Default createConnection 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    databaseType: Oracle
                    host: example_value
                    port: 10
                    serviceName: example_value
                    schema: example_value
                    agentHost: example_value
                    agentPort: 10
        '400':
          $ref: '#/components/responses/BadRequest_3'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    servers:
    - url: https://{veridata-host}:{port}/veridata/v1
      description: Oracle GoldenGate Veridata server
      variables:
        veridata-host:
          default: localhost
          description: Veridata server host
        port:
          default: '8830'
          description: Veridata HTTPS port
  /services/configuration/connections/{Id}:
    get:
      operationId: getConnection
      summary: Oracle Goldengate Retrieve a Connection
      description: Returns the details of a specific database connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam_2'
      responses:
        '200':
          description: Connection retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection_2'
              examples:
                Getconnection200Example:
                  summary: Default getConnection 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    databaseType: Oracle
                    host: example_value
                    port: 10
                    serviceName: example_value
                    schema: example_value
                    agentHost: example_value
                    agentPort: 10
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_3'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    patch:
      operationId: updateConnection
      summary: Oracle Goldengate Update a Connection
      description: Updates properties of an existing database connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam_2'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectionRequest'
            examples:
              UpdateconnectionRequestExample:
                summary: Default updateConnection request
                x-microcks-default: true
                value:
                  name: Example Title
                  description: A sample description.
                  host: example_value
                  port: 10
                  username: example_value
                  password: example_value
      responses:
        '200':
          description: Connection updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection_2'
              examples:
                Updateconnection200Example:
                  summary: Default updateConnection 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    databaseType: Oracle
                    host: example_value
                    port: 10
                    serviceName: example_value
                    schema: example_value
                    agentHost: example_value
                    agentPort: 10
        '400':
          $ref: '#/components/responses/BadRequest_3'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_3'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    delete:
      operationId: deleteConnection
      summary: Oracle Goldengate Delete a Connection
      description: Deletes a database connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam_2'
      responses:
        '204':
          description: Connection deleted
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_3'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    servers:
    - url: https://{veridata-host}:{port}/veridata/v1
      description: Oracle GoldenGate Veridata server
      variables:
        veridata-host:
          default: localhost
          description: Veridata server host
        port:
          default: '8830'
          description: Veridata HTTPS port
  /services/configuration/connections/{Id}/status:
    get:
      operationId: getConnectionStatus
      summary: Oracle Goldengate Retrieve Connection Status
      description: Returns the connectivity status of a database connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam_2'
      responses:
        '200':
          description: Connection status retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionStatus'
              examples:
                Getconnectionstatus200Example:
    

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