Oracle GoldenGate Deployments API

Manage GoldenGate deployment instances

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

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/oracle-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.

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:


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