Oracle GoldenGate

Oracle GoldenGate Database Registrations API

Manage registered source and target databases

GitHub OpenAPI

Operations 5

GET /20200407/databaseRegistrations Oracle Goldengate List Database Registrations #
POST /20200407/databaseRegistrations Oracle Goldengate Create a Database Registration #
GET /20200407/databaseRegistrations/{databaseRegistrationId} Oracle Goldengate Get a Database Registration #
PUT /20200407/databaseRegistrations/{databaseRegistrationId} Oracle Goldengate Update a Database Registration #
DELETE /20200407/databaseRegistrations/{databaseRegistrationId} Oracle Goldengate Delete a Database Registration #

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-database-registrations-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-database-registrations-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-database-registrations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Oracle GoldenGate Cloud Service Database Registrations 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: Database Registrations
  description: Manage registered source and target databases
paths:
  /20200407/databaseRegistrations:
    get:
      operationId: listDatabaseRegistrations
      summary: Oracle Goldengate List Database Registrations
      description: Returns a list of registered databases.
      tags:
      - Database Registrations
      parameters:
      - $ref: '#/components/parameters/compartmentIdParam'
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/pageParam'
      responses:
        '200':
          description: Registrations listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseRegistrationCollection'
              examples:
                Listdatabaseregistrations200Example:
                  summary: Default listDatabaseRegistrations 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - id: abc123
                      displayName: example_value
                      databaseId: '500123'
                      lifecycleState: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createDatabaseRegistration
      summary: Oracle Goldengate Create a Database Registration
      description: Registers a database for use with GoldenGate.
      tags:
      - Database Registrations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDatabaseRegistrationDetails'
            examples:
              CreatedatabaseregistrationRequestExample:
                summary: Default createDatabaseRegistration request
                x-microcks-default: true
                value:
                  displayName: example_value
                  description: A sample description.
                  compartmentId: '500123'
                  fqdn: example_value
                  username: example_value
                  password: example_value
                  connectionString: example_value
                  databaseId: '500123'
      responses:
        '200':
          description: Registration initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseRegistration'
              examples:
                Createdatabaseregistration200Example:
                  summary: Default createDatabaseRegistration 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    displayName: example_value
                    description: A sample description.
                    compartmentId: '500123'
                    databaseId: '500123'
                    connectionString: example_value
                    username: example_value
                    fqdn: example_value
                    lifecycleState: example_value
                    timeCreated: '2026-01-15T10:30:00Z'
          headers:
            opc-work-request-id:
              schema:
                type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /20200407/databaseRegistrations/{databaseRegistrationId}:
    get:
      operationId: getDatabaseRegistration
      summary: Oracle Goldengate Get a Database Registration
      description: Returns the details of a database registration.
      tags:
      - Database Registrations
      parameters:
      - name: databaseRegistrationId
        in: path
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: Registration retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseRegistration'
              examples:
                Getdatabaseregistration200Example:
                  summary: Default getDatabaseRegistration 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    displayName: example_value
                    description: A sample description.
                    compartmentId: '500123'
                    databaseId: '500123'
                    connectionString: example_value
                    username: example_value
                    fqdn: example_value
                    lifecycleState: example_value
                    timeCreated: '2026-01-15T10:30:00Z'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateDatabaseRegistration
      summary: Oracle Goldengate Update a Database Registration
      description: Updates a database registration.
      tags:
      - Database Registrations
      parameters:
      - name: databaseRegistrationId
        in: path
        required: true
        schema:
          type: string
        example: '500123'
      - $ref: '#/components/parameters/ifMatchParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDatabaseRegistrationDetails'
            examples:
              UpdatedatabaseregistrationRequestExample:
                summary: Default updateDatabaseRegistration request
                x-microcks-default: true
                value:
                  displayName: example_value
                  description: A sample description.
                  fqdn: example_value
                  username: example_value
                  password: example_value
                  connectionString: 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: deleteDatabaseRegistration
      summary: Oracle Goldengate Delete a Database Registration
      description: Deletes a database registration.
      tags:
      - Database Registrations
      parameters:
      - name: databaseRegistrationId
        in: path
        required: true
        schema:
          type: string
        example: '500123'
      - $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
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
    DatabaseRegistrationSummary:
      type: object
      properties:
        id:
          type: string
          example: abc123
        displayName:
          type: string
          example: example_value
        databaseId:
          type: string
          example: '500123'
        lifecycleState:
          type: string
          example: example_value
    DatabaseRegistration:
      type: object
      properties:
        id:
          type: string
          example: abc123
        displayName:
          type: string
          example: example_value
        description:
          type: string
          example: A sample description.
        compartmentId:
          type: string
          example: '500123'
        databaseId:
          type: string
          example: '500123'
        connectionString:
          type: string
          example: example_value
        username:
          type: string
          example: example_value
        fqdn:
          type: string
          example: example_value
        lifecycleState:
          type: string
          example: example_value
        timeCreated:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    UpdateDatabaseRegistrationDetails:
      type: object
      properties:
        displayName:
          type: string
          example: example_value
        description:
          type: string
          example: A sample description.
        fqdn:
          type: string
          example: example_value
        username:
          type: string
          example: example_value
        password:
          type: string
          format: password
          example: example_value
        connectionString:
          type: string
          example: example_value
    CreateDatabaseRegistrationDetails:
      type: object
      required:
      - displayName
      - compartmentId
      - fqdn
      - username
      - password
      - connectionString
      properties:
        displayName:
          type: string
          example: example_value
        description:
          type: string
          example: A sample description.
        compartmentId:
          type: string
          example: '500123'
        fqdn:
          type: string
          example: example_value
        username:
          type: string
          example: example_value
        password:
          type: string
          format: password
          example: example_value
        connectionString:
          type: string
          example: example_value
        databaseId:
          type: string
          example: '500123'
    DatabaseRegistrationCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseRegistrationSummary'
          example: []
  parameters:
    compartmentIdParam:
      name: compartmentId
      in: query
      required: true
      description: The OCID of the compartment
      schema:
        type: string
    limitParam:
      name: limit
      in: query
      description: Maximum number of items to return
      schema:
        type: integer
        minimum: 1
        maximum: 1000
        default: 10
    pageParam:
      name: page
      in: query
      description: Pagination token
      schema:
        type: string
    ifMatchParam:
      name: if-match
      in: header
      description: ETag for optimistic concurrency control
      schema:
        type: string
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ociSignature:
      type: http
      scheme: bearer
      description: OCI API request signature (RFC 7616) or bearer token authentication