Oracle GoldenGate

Oracle GoldenGate Deployments API

Manage GoldenGate deployment instances

GitHub OpenAPI

Operations 15

GET /20200407/deployments Oracle Goldengate List Deployments #
POST /20200407/deployments Oracle Goldengate Create a Deployment #
GET /20200407/deployments/{deploymentId} Oracle Goldengate Get a Deployment #
PUT /20200407/deployments/{deploymentId} Oracle Goldengate Update a Deployment #
DELETE /20200407/deployments/{deploymentId} Oracle Goldengate Delete a Deployment #
POST /20200407/deployments/{deploymentId}/actions/start Oracle Goldengate Start a Deployment #
POST /20200407/deployments/{deploymentId}/actions/stop Oracle Goldengate Stop a Deployment #
POST /20200407/deployments/{deploymentId}/actions/upgrade Oracle Goldengate Upgrade a Deployment #
POST /20200407/deployments/{deploymentId}/actions/changeCompartment Oracle Goldengate Change Deployment Compartment #
POST /20200407/deployments/{deploymentId}/actions/collectDiagnostics Oracle Goldengate Collect Deployment Diagnostics #
GET /services/v2/deployments Oracle Goldengate List All Deployments #
GET /services/v2/deployments/{deployment} Oracle Goldengate Retrieve a Deployment #
POST /services/v2/deployments/{deployment} Oracle Goldengate Create a Deployment #
PATCH /services/v2/deployments/{deployment} Oracle Goldengate Update a Deployment #
DELETE /services/v2/deployments/{deployment} Oracle Goldengate Remove a Deployment #

Documentation

📖
Documentation
https://docs.oracle.com/en/middleware/goldengate/core/21.3/oggra/index.html
📖
Authentication
https://docs.oracle.com/en/middleware/goldengate/core/21.3/oggra/authentication.html
📖
Documentation
https://docs.oracle.com/en/database/goldengate/core/26/oggra/index.html
📖
Authentication
https://docs.oracle.com/en/database/goldengate/core/26/oggra/authenticate.html
📖
GettingStarted
https://docs.oracle.com/en/database/goldengate/core/26/
📖
Documentation
https://docs.oracle.com/en/middleware/goldengate/big-data/21.3/gadbd/index.html
📖
GettingStarted
https://docs.oracle.com/en/middleware/goldengate/big-data/21.3/gadbd/getting-started.html
📖
Documentation
https://docs.oracle.com/en/middleware/goldengate/veridata/12.2.1.4/gvdug/index.html
📖
APIReference
https://docs.oracle.com/en/middleware/goldengate/veridata/12.2.1.4/gvdra/index.html
📖
Documentation
https://docs.oracle.com/en/database/goldengate/veridata/26/
📖
Documentation
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/latest/
📖
GettingStarted
https://docs.oracle.com/en/cloud/paas/goldengate-service/index.html
📖
Authentication
https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm
📖
APIReference
https://docs.oracle.com/en-us/iaas/goldengate/doc/using-rest-api.html
📖
Documentation
https://docs.oracle.com/en/database/goldengate/stream-analytics/26/
📖
APIReference
https://docs.oracle.com/en/middleware/fusion-middleware/osa/19.1/ggsa-rest-api/quick-start.html
📖
GettingStarted
https://docs.oracle.com/en/database/goldengate/stream-analytics/26/
📖
Documentation
https://docs.oracle.com/en/database/goldengate/core/26/coredoc/distribute-datastream-rest-api.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/oracle-goldengate/refs/heads/main/openapi/oracle-goldengate-deployments-api-openapi.yml

Other Resources

🔗
Tutorials
https://docs.oracle.com/en/database/goldengate/core/26/tutorials.html
🔗
ChangeLog
https://docs.oracle.com/en/database/goldengate/core/26/release-notes/
🔗
ChangeLog
https://docs.oracle.com/en/database/goldengate/veridata/26/gvdrn/index.html
🔗
SDKs
https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdks.htm
🔗
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/
🔗
SDKs
https://docs.oracle.com/en-us/iaas/tools/python/latest/api/golden_gate.html
🔗
ChangeLog
https://docs.oracle.com/en/database/goldengate/stream-analytics/26/release-notes/release-notes-goldengate-stream-analytics.pdf

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-deployments-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

oracle-goldengate-deployments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Oracle Goldengate Deployments 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 Deployments across 2 of this provider''s published API definitions: oracle-goldengate-cloud-service-api-openapi.yml, oracle-goldengate-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
tags:
- name: Deployments
  description: Manage GoldenGate deployment instances
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
      security:
      - ociSignature: []
    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
      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/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
      security:
      - ociSignature: []
    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
      security:
      - ociSignature: []
    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
      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/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
      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/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
      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/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
      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/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
      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/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
      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/deployments:
    get:
      operationId: listDeployments
      summary: Oracle Goldengate List All Deployments
      description: Returns a list of all GoldenGate deployments managed by the Service Manager.
      tags:
      - Deployments
      responses:
        '200':
          description: Successfully retrieved deployment list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentList'
              examples:
                Listdeployments200Example:
                  summary: Default listDeployments 200 response
                  x-microcks-default: true
                  value:
                    deployments:
                    - name: Example Title
                      status: example_value
                      description: A sample description.
        '401':
          $ref: '#/components/responses/Unauthorized_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/deployments/{deployment}:
    get:
      operationId: getDeployment
      summary: Oracle Goldengate Retrieve a Deployment
      description: Returns the configuration details of a specific GoldenGate deployment.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentParam'
      responses:
        '200':
          description: Deployment details retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment_2'
              examples:
                Getdeployment200Example:
                  summary: Default getDeployment 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: running
                    description: A sample description.
                    oggHome: example_value
                    oggVersion: example_value
                    environmentVariables: example_value
                    services:
                    - name: Example Title
                      type: example_value
                      status: example_value
                      port: 10
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    post:
      operationId: createDeployment
      summary: Oracle Goldengate Create a Deployment
      description: Creates a new GoldenGate deployment with the specified configuration.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeploymentRequest'
            examples:
              CreatedeploymentRequestExample:
                summary: Default createDeployment request
                x-microcks-default: true
                value:
                  oggHome: example_value
                  description: A sample description.
                  environmentVariables: example_value
                  autoStart: true
      responses:
        '201':
          description: Deployment created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment_2'
              examples:
                Createdeployment201Example:
                  summary: Default createDeployment 201 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: running
                    description: A sample description.
                    oggHome: example_value
                    oggVersion: example_value
                    environmentVariables: example_value
                    services:
                    - name: Example Title
                      type: example_value
                      status: example_value
                      port: 10
        '400':
          $ref: '#/components/responses/BadRequest_2'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '409':
          $ref: '#/components/responses/Conflict'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    patch:
      operationId: updateDeployment
      summary: Oracle Goldengate Update a Deployment
      description: Updates configuration properties of an existing GoldenGate deployment.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDeploymentRequest'
            examples:
              UpdatedeploymentRequestExample:
                summary: Default updateDeployment request
                x-microcks-default: true
                value:
                  description: A sample description.
                  environmentVariables: example_value
                  autoStart: true
      responses:
        '200':
          description: Deployment updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment_2'
              examples:
                Updatedeployment200Example:
                  summary: Default updateDeployment 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: running
                    description: A sample description.
                    oggHome: example_value
                    oggVersion: example_value
                    environmentVariables: example_value
                    services:
                    - name: Example Title
                      type: example_value
                      status: example_value
                      port: 10
        '400':
          $ref: '#/components/responses/BadRequest_2'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    delete:
      operationId: deleteDeployment
      summary: Oracle Goldengate Remove a Deployment
      description: Removes a GoldenGate deployment and its associated services.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentParam'
      responses:
        '204':
          description: Deployment removed successfully
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '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
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
    CollectDiagnosticsDetails:
      type: object
      required:
      - namespaceName
      - bucketName
      - diagnosticNamePrefix
      properties:
        namespaceName:
          type: string
          example: example_value
        bucketName:
          type: string
          example: example_value
        diagnosticNamePrefix:
          type: string
          example: example_value
    ChangeCompartmentDetails:
      type: object
      required:
      - compartmentId
      properties:
        compartmentId:
          type: string
          example: '500123'
    CreateDeploymentDetails:
      type: object
      required:
      - displayName
      - compartmentId
      - subnetId
      - licenseModel
      - cpuCoreCount
      - isAutoScalingEnabled
      properties:
        displayName:
          type: string
          example: example_value
        description:
          type: string
          example: A sample description.
        compartmentId:
          type: string
          example: '500123'
        subnetId:
          type: string
          example: '500123'
        licenseModel:
          type: string
          enum:
          - LICENSE_INCLUDED
          - BRING_YOUR_OWN_LICENSE
          example: LICENSE_INCLUDED
        fqdn:
          type: string
          example: example_value
        cpuCoreCount:
          type: integer
          example: 10
        isAutoScalingEnabled:
          type: boolean
          example: true
        isPublic:
          type: boolean
          example: true
        oggData:
          type: object
          required:
          - deploymentName
          - adminUsername
          - adminPassword
          properties:
            deploymentName:
              type: string
            adminUsername:
              type: string
            adminPassword:
              type: string
              format: password
          example: example_value
        freeformTags:
          type: object
          additionalProperties:
            type: string
          example: example_value
        definedTags:
          type: object
          additionalProperties:
            type: object
          example: example_value
    DeploymentCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DeploymentSummary'
          example: []
    StopDeploymentDetails:
      type: object
      required:
      - type
      properties:
        type:
          type: string
          enum:
          - DEFAULT
          example: DEFAULT
    Deployment:
      type: object
      properties:
        id:
          type: string
          description: OCID of the deployment
          example: abc123
        displayName:
          type: string
          example: example_value
        description:
          type: string
          example: A sample description.
        compartmentId:
          type: string
          example: '500123'
        subnetId:
          type: string
          example: '500123'
        licenseModel:
          type: string
          enum:
          - LICENSE_INCLUDED
          - BRING_YOUR_OWN_LICENSE
          example: LICENSE_INCLUDED
        fqdn:
          type: string
          example: example_value
        cpuCoreCount:
          type: integer
          example: 10
        isAutoScalingEnabled:
          type: boolean
          example: true
        isPublic:
          type: boolean
          example: true
        publicIpAddress:
          type: string
          example: example_value
        privateIpAddress:
          type: string
          example: example_value
        deploymentUrl:
          type: string
          example: https://www.example.com
        lifecycleState:
          type: string
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - INACTIVE
          - DELETING
          - DELETED
          - FAILED
          - NEEDS_ATTENTION
          - IN_PROGRESS
          - CANCELING
          - CANCELED
          - SUCCEEDED
          example: CREATING
        oggData:
          type: object
          properties:
            deploymentName:
              type: string
            adminUsername:
              type: string
            oggVersion:
              type: string
            certificate:
              type: string
          example: example_value
        timeCreated:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        timeUpdated:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        freeformTags:
          type: object
          additionalProperties:
            type: string
          example: example_value
        definedTags:
          type: object
          additionalProperties:
            type: object
          example: example_value
    DeploymentSummary:
      type: object
      properties:
        id:
          type: string
          des

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