Oracle GoldenGate Cloud Service API

Oracle Cloud Infrastructure API for managing GoldenGate deployments in OCI.

Documentation

Specifications

SDKs

Other Resources

🔗
CLI
https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cliconcepts.htm
🔗
Tutorials
https://docs.oracle.com/en/cloud/paas/goldengate-service/tutorials.html
🔗
ChangeLog
https://docs.oracle.com/en-us/iaas/releasenotes/services/goldengate/
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/oracle-goldengate/refs/heads/main/capabilities/cloud-service-certificates.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/oracle-goldengate/refs/heads/main/capabilities/cloud-service-connection-assignments.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/oracle-goldengate/refs/heads/main/capabilities/cloud-service-connections.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/oracle-goldengate/refs/heads/main/capabilities/cloud-service-database-registrations.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/oracle-goldengate/refs/heads/main/capabilities/cloud-service-deployment-backups.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/oracle-goldengate/refs/heads/main/capabilities/cloud-service-deployment-versions.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/oracle-goldengate/refs/heads/main/capabilities/cloud-service-deployments.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/oracle-goldengate/refs/heads/main/capabilities/cloud-service-pipelines.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/oracle-goldengate/refs/heads/main/capabilities/cloud-service-work-requests.yaml

OpenAPI Specification

oracle-goldengate-cloud-service-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Oracle GoldenGate Cloud Service API
  description: >-
    Oracle Cloud Infrastructure (OCI) API for managing GoldenGate deployments,
    connections, deployment backups, database registrations, pipelines,
    connection assignments, certificates, and work requests in OCI. This is the
    OCI control-plane API (version 20200407) for provisioning and managing
    GoldenGate cloud resources. Based on the OCI GoldenGate API documentation
    and Python SDK reference.
  version: '20200407'
  contact:
    name: Oracle Support
    url: https://support.oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/legal/terms.html
  x-documentation:
  - url: https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
    description: OCI GoldenGate API Reference
  - url: https://docs.oracle.com/en-us/iaas/tools/python/latest/api/golden_gate.html
    description: OCI Python SDK - GoldenGate Client
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
security:
- ociSignature: []
tags:
- name: Certificates
  description: Manage SSL certificates for deployments
- name: Connection Assignments
  description: Manage connection-to-deployment assignments
- name: Connections
  description: Manage database and service connections
- name: Database Registrations
  description: Manage registered source and target databases
- name: Deployment Backups
  description: Manage deployment backups
- name: Deployment Versions
  description: Query available deployment versions
- name: Deployments
  description: Manage GoldenGate deployment instances
- name: Pipelines
  description: Manage data replication pipelines
- name: Work Requests
  description: Track asynchronous operations
paths:
  /20200407/deployments:
    get:
      operationId: listDeployments
      summary: Oracle Goldengate List Deployments
      description: Returns a list of GoldenGate deployments in the specified compartment.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/compartmentIdParam'
      - $ref: '#/components/parameters/lifecycleStateParam'
      - $ref: '#/components/parameters/displayNameParam'
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/pageParam'
      - $ref: '#/components/parameters/sortByParam'
      - $ref: '#/components/parameters/sortOrderParam'
      responses:
        '200':
          description: Deployment list retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentCollection'
              examples:
                Listdeployments200Example:
                  summary: Default listDeployments 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - id: abc123
                      displayName: example_value
                      compartmentId: '500123'
                      lifecycleState: example_value
                      timeCreated: '2026-01-15T10:30:00Z'
                      timeUpdated: '2026-01-15T10:30:00Z'
          headers:
            opc-next-page:
              schema:
                type: string
            opc-request-id:
              schema:
                type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createDeployment
      summary: Oracle Goldengate Create a Deployment
      description: Creates a new GoldenGate deployment in the specified compartment.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/opcRetryTokenParam'
      - $ref: '#/components/parameters/opcRequestIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeploymentDetails'
            examples:
              CreatedeploymentRequestExample:
                summary: Default createDeployment request
                x-microcks-default: true
                value:
                  displayName: example_value
                  description: A sample description.
                  compartmentId: '500123'
                  subnetId: '500123'
                  licenseModel: LICENSE_INCLUDED
                  fqdn: example_value
                  cpuCoreCount: 10
                  isAutoScalingEnabled: true
                  isPublic: true
                  oggData:
                    deploymentName: example_value
                    adminUsername: example_value
                    adminPassword: example_value
                  freeformTags: example_value
                  definedTags: example_value
      responses:
        '200':
          description: Deployment creation initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
              examples:
                Createdeployment200Example:
                  summary: Default createDeployment 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    displayName: example_value
                    description: A sample description.
                    compartmentId: '500123'
                    subnetId: '500123'
                    licenseModel: LICENSE_INCLUDED
                    fqdn: example_value
                    cpuCoreCount: 10
                    isAutoScalingEnabled: true
                    isPublic: true
                    publicIpAddress: example_value
                    privateIpAddress: example_value
                    deploymentUrl: https://www.example.com
                    lifecycleState: CREATING
                    oggData:
                      deploymentName: example_value
                      adminUsername: example_value
                      oggVersion: example_value
                      certificate: example_value
                    timeCreated: '2026-01-15T10:30:00Z'
                    timeUpdated: '2026-01-15T10:30:00Z'
                    freeformTags: example_value
                    definedTags: example_value
          headers:
            opc-work-request-id:
              schema:
                type: string
            opc-request-id:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /20200407/deployments/{deploymentId}:
    get:
      operationId: getDeployment
      summary: Oracle Goldengate Get a Deployment
      description: Returns the details of a specific GoldenGate deployment.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentIdParam'
      responses:
        '200':
          description: Deployment retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
              examples:
                Getdeployment200Example:
                  summary: Default getDeployment 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    displayName: example_value
                    description: A sample description.
                    compartmentId: '500123'
                    subnetId: '500123'
                    licenseModel: LICENSE_INCLUDED
                    fqdn: example_value
                    cpuCoreCount: 10
                    isAutoScalingEnabled: true
                    isPublic: true
                    publicIpAddress: example_value
                    privateIpAddress: example_value
                    deploymentUrl: https://www.example.com
                    lifecycleState: CREATING
                    oggData:
                      deploymentName: example_value
                      adminUsername: example_value
                      oggVersion: example_value
                      certificate: example_value
                    timeCreated: '2026-01-15T10:30:00Z'
                    timeUpdated: '2026-01-15T10:30:00Z'
                    freeformTags: example_value
                    definedTags: example_value
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateDeployment
      summary: Oracle Goldengate Update a Deployment
      description: Updates the configuration of a GoldenGate deployment.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentIdParam'
      - $ref: '#/components/parameters/ifMatchParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDeploymentDetails'
            examples:
              UpdatedeploymentRequestExample:
                summary: Default updateDeployment request
                x-microcks-default: true
                value:
                  displayName: example_value
                  description: A sample description.
                  fqdn: example_value
                  cpuCoreCount: 10
                  isAutoScalingEnabled: true
                  isPublic: true
                  freeformTags: example_value
      responses:
        '200':
          description: Update initiated
          headers:
            opc-work-request-id:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteDeployment
      summary: Oracle Goldengate Delete a Deployment
      description: Deletes a GoldenGate deployment.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentIdParam'
      - $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
  /20200407/deployments/{deploymentId}/actions/start:
    post:
      operationId: startDeployment
      summary: Oracle Goldengate Start a Deployment
      description: Starts a stopped GoldenGate deployment.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentIdParam'
      - $ref: '#/components/parameters/ifMatchParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartDeploymentDetails'
            examples:
              StartdeploymentRequestExample:
                summary: Default startDeployment request
                x-microcks-default: true
                value:
                  type: DEFAULT
      responses:
        '202':
          description: Start initiated
          headers:
            opc-work-request-id:
              schema:
                type: string
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /20200407/deployments/{deploymentId}/actions/stop:
    post:
      operationId: stopDeployment
      summary: Oracle Goldengate Stop a Deployment
      description: Stops a running GoldenGate deployment.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentIdParam'
      - $ref: '#/components/parameters/ifMatchParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopDeploymentDetails'
            examples:
              StopdeploymentRequestExample:
                summary: Default stopDeployment request
                x-microcks-default: true
                value:
                  type: DEFAULT
      responses:
        '202':
          description: Stop initiated
          headers:
            opc-work-request-id:
              schema:
                type: string
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /20200407/deployments/{deploymentId}/actions/upgrade:
    post:
      operationId: upgradeDeployment
      summary: Oracle Goldengate Upgrade a Deployment
      description: Upgrades a GoldenGate deployment to a newer version.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentIdParam'
      - $ref: '#/components/parameters/ifMatchParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpgradeDeploymentDetails'
            examples:
              UpgradedeploymentRequestExample:
                summary: Default upgradeDeployment request
                x-microcks-default: true
                value:
                  type: CURRENT_RELEASE
                  oggVersion: example_value
      responses:
        '202':
          description: Upgrade initiated
          headers:
            opc-work-request-id:
              schema:
                type: string
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /20200407/deployments/{deploymentId}/actions/changeCompartment:
    post:
      operationId: changeDeploymentCompartment
      summary: Oracle Goldengate Change Deployment Compartment
      description: Moves a deployment to a different compartment.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentIdParam'
      - $ref: '#/components/parameters/ifMatchParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeCompartmentDetails'
            examples:
              ChangedeploymentcompartmentRequestExample:
                summary: Default changeDeploymentCompartment request
                x-microcks-default: true
                value:
                  compartmentId: '500123'
      responses:
        '202':
          description: Compartment change initiated
          headers:
            opc-work-request-id:
              schema:
                type: string
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /20200407/deployments/{deploymentId}/actions/collectDiagnostics:
    post:
      operationId: collectDeploymentDiagnostics
      summary: Oracle Goldengate Collect Deployment Diagnostics
      description: Collects diagnostic information from a GoldenGate deployment.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentIdParam'
      - $ref: '#/components/parameters/ifMatchParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CollectDiagnosticsDetails'
            examples:
              CollectdeploymentdiagnosticsRequestExample:
                summary: Default collectDeploymentDiagnostics request
                x-microcks-default: true
                value:
                  namespaceName: example_value
                  bucketName: example_value
                  diagnosticNamePrefix: example_value
      responses:
        '202':
          description: Diagnostic collection initiated
          headers:
            opc-work-request-id:
              schema:
                type: string
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /20200407/deploymentBackups:
    get:
      operationId: listDeploymentBackups
      summary: Oracle Goldengate List Deployment Backups
      description: Returns a list of deployment backups in the specified compartment.
      tags:
      - Deployment Backups
      parameters:
      - $ref: '#/components/parameters/compartmentIdParam'
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/pageParam'
      responses:
        '200':
          description: Backup list retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentBackupCollection'
              examples:
                Listdeploymentbackups200Example:
                  summary: Default listDeploymentBackups 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - id: abc123
                      deploymentId: '500123'
                      displayName: example_value
                      lifecycleState: example_value
                      timeCreated: '2026-01-15T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createDeploymentBackup
      summary: Oracle Goldengate Create a Deployment Backup
      description: Creates a backup of a GoldenGate deployment.
      tags:
      - Deployment Backups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeploymentBackupDetails'
            examples:
              CreatedeploymentbackupRequestExample:
                summary: Default createDeploymentBackup request
                x-microcks-default: true
                value:
                  displayName: example_value
                  compartmentId: '500123'
                  deploymentId: '500123'
                  namespaceName: example_value
                  bucketName: example_value
                  objectName: example_value
      responses:
        '200':
          description: Backup creation initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentBackup'
              examples:
                Createdeploymentbackup200Example:
                  summary: Default createDeploymentBackup 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    deploymentId: '500123'
                    displayName: example_value
                    compartmentId: '500123'
                    lifecycleState: example_value
                    sizeInBytes: 10
                    backupType: INCREMENTAL
                    oggVersion: example_value
                    timeCreated: '2026-01-15T10:30:00Z'
          headers:
            opc-work-request-id:
              schema:
                type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /20200407/deploymentBackups/{deploymentBackupId}:
    get:
      operationId: getDeploymentBackup
      summary: Oracle Goldengate Get a Deployment Backup
      description: Returns the details of a specific deployment backup.
      tags:
      - Deployment Backups
      parameters:
      - $ref: '#/components/parameters/deploymentBackupIdParam'
      responses:
        '200':
          description: Backup retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentBackup'
              examples:
                Getdeploymentbackup200Example:
                  summary: Default getDeploymentBackup 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    deploymentId: '500123'
                    displayName: example_value
                    compartmentId: '500123'
                    lifecycleState: example_value
                    sizeInBytes: 10
                    backupType: INCREMENTAL
                    oggVersion: example_value
                    timeCreated: '2026-01-15T10:30:00Z'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteDeploymentBackup
      summary: Oracle Goldengate Delete a Deployment Backup
      description: Deletes a deployment backup.
      tags:
      - Deployment Backups
      parameters:
      - $ref: '#/components/parameters/deploymentBackupIdParam'
      - $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
  /20200407/deploymentBackups/{deploymentBackupId}/actions/restore:
    post:
      operationId: restoreDeployment
      summary: Oracle Goldengate Restore a Deployment From Backup
      description: Restores a GoldenGate deployment from a backup.
      tags:
      - Deployment Backups
      parameters:
      - $ref: '#/components/parameters/deploymentBackupIdParam'
      - $ref: '#/components/parameters/ifMatchParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreDeploymentDetails'
            examples:
              RestoredeploymentRequestExample:
                summary: Default restoreDeployment request
                x-microcks-default: true
                value:
                  type: DEFAULT
      responses:
        '202':
          description: Restore initiated
          headers:
            opc-work-request-id:
              schema:
                type: string
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
    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
  /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
    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
    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
  /20200407/connectionAssignments:
    get:
      operationId: listConnectionAssignments
      summary: Oracle Goldengate List Connection Assignments
      description: Returns connection-to-deployment assignments.
      tags:
      - Connection Assignments
      parameters:
      - $ref: '#/components/parameters/compartmentIdParam'
      - name: deploymentId
        in: query
        schema:
          type: string
        example: '500123'
      - name: connectionId
        in: query
        schema:
          type: string
        example: '500123'
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/pageParam'
      responses:
        '200':
          description: Assignments listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionAssignmentCollection'
              examples:
                Listconnectionassignments200Example:
                  summary: Default listConnectionAssignments 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - id: abc123
                      connectionId: '500123'
                      deploymentId: '500123'
                      lifecycleState: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createConnectionAssignment
      summary: Oracle Goldengate Create a Connection Assignment
      description: Assigns a connection to a deployment for use in replication.
      tags:
      - Connection Assignments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectionAssignmentDetails'
            examples:
              CreateconnectionassignmentRequestExample:
                summary: Default createConnectionAssignment request
                x-microcks-default: true
                value:
                  connectionId: '500123'
                  deploymentId: '500123'
      responses:
        '200':
          description: Assignment creation initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionAssignment'
              examples:
                Createconnectionassignment200Example:
                  summary: Default createConnectionAssignment 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    connectionId: '500123'
                    deploymentId: '500123'
                    compartmentId: '500123'
           

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