Oracle GoldenGate

Oracle GoldenGate Distribution API

Distribution paths for trail data delivery

GitHub OpenAPI

Operations 7

GET /services/v2/sources Oracle Goldengate List Distribution Paths #
GET /services/v2/sources/{distpath} Oracle Goldengate Retrieve a Distribution Path #
POST /services/v2/sources/{distpath} Oracle Goldengate Create a Distribution Path #
DELETE /services/v2/sources/{distpath} Oracle Goldengate Delete a Distribution Path #
PATCH /services/v2/sources/{distpath} Oracle Goldengate Update a Distribution Path #
GET /services/v2/sources/{distpath}/stats Oracle Goldengate Retrieve Distribution Path Statistics #
GET /services/v2/exttrails Oracle Goldengate List Deployment Extracts With Trail Files #

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-distribution-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-distribution-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-distribution-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Oracle Goldengate Distribution API
  version: 21.3.0
  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
  description: 'Operations tagged Distribution across 2 of this provider''s published API definitions: oracle-goldengate-big-data-rest-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-host}:{port}
  description: Oracle GoldenGate for Big Data Microservices server
  variables:
    goldengate-host:
      default: localhost
      description: GoldenGate Big Data host
    port:
      default: '443'
      description: HTTPS port
security:
- basicAuth: []
tags:
- name: Distribution
  description: Distribution paths for trail data delivery
paths:
  /services/v2/sources:
    get:
      operationId: listDistributionPaths
      summary: Oracle Goldengate List Distribution Paths
      description: Returns distribution paths configured for big data deployments.
      tags:
      - Distribution
      responses:
        '200':
          description: Paths listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributionPathList'
              examples:
                Listdistributionpaths200Example:
                  summary: Default listDistributionPaths 200 response
                  x-microcks-default: true
                  value:
                    paths:
                    - name: Example Title
                      status: example_value
                      source: example_value
                      target: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate for Big Data Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Big Data host
        port:
          default: '443'
          description: HTTPS port
  /services/v2/sources/{distpath}:
    get:
      operationId: getDistributionPath
      summary: Oracle Goldengate Retrieve a Distribution Path
      description: Returns a specific distribution path.
      tags:
      - Distribution
      parameters:
      - $ref: '#/components/parameters/distpathParam'
      responses:
        '200':
          description: Path retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributionPath'
              examples:
                Getdistributionpath200Example:
                  summary: Default getDistributionPath 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: example_value
                    source: example_value
                    target: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createDistributionPath
      summary: Oracle Goldengate Create a Distribution Path
      description: Creates a distribution path for delivering trail data to a big data deployment.
      tags:
      - Distribution
      parameters:
      - $ref: '#/components/parameters/distpathParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDistributionPathRequest'
            examples:
              CreatedistributionpathRequestExample:
                summary: Default createDistributionPath request
                x-microcks-default: true
                value:
                  source: example_value
                  target: example_value
      responses:
        '201':
          description: Path created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributionPath'
              examples:
                Createdistributionpath201Example:
                  summary: Default createDistributionPath 201 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: example_value
                    source: example_value
                    target: example_value
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteDistributionPath
      summary: Oracle Goldengate Delete a Distribution Path
      description: Deletes a distribution path.
      tags:
      - Distribution
      parameters:
      - $ref: '#/components/parameters/distpathParam'
      responses:
        '204':
          description: Path deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateDistributionPath
      summary: Oracle Goldengate Update a Distribution Path
      description: Updates the configuration of an existing distribution path.
      tags:
      - Distribution
      parameters:
      - $ref: '#/components/parameters/distpathParam_2'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDistributionPathRequest'
            examples:
              UpdatedistributionpathRequestExample:
                summary: Default updateDistributionPath request
                x-microcks-default: true
                value:
                  source: example_value
                  target: example_value
                  status: example_value
      responses:
        '200':
          description: Distribution path updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributionPath_2'
              examples:
                Updatedistributionpath200Example:
                  summary: Default updateDistributionPath 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: running
                    source: example_value
                    target: example_value
                    targetType: example_value
                    ruleName: example_value
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate for Big Data Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Big Data host
        port:
          default: '443'
          description: HTTPS port
  /services/v2/sources/{distpath}/stats:
    get:
      operationId: getDistributionPathStats
      summary: Oracle Goldengate Retrieve Distribution Path Statistics
      description: Returns performance statistics for a distribution path.
      tags:
      - Distribution
      parameters:
      - $ref: '#/components/parameters/distpathParam_2'
      responses:
        '200':
          description: Statistics retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PathStatistics'
              examples:
                Getdistributionpathstats200Example:
                  summary: Default getDistributionPathStats 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    bytesProcessed: 10
                    messagesProcessed: 10
                    lag: example_value
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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/exttrails:
    get:
      operationId: listExtractTrails
      summary: Oracle Goldengate List Deployment Extracts With Trail Files
      description: Returns a list of extracts and their associated trail files for the Distribution Server.
      tags:
      - Distribution
      responses:
        '200':
          description: Extract trails listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractTrailList'
              examples:
                Listextracttrails200Example:
                  summary: Default listExtractTrails 200 response
                  x-microcks-default: true
                  value:
                    extracts:
                    - extractName: example_value
                      trail: example_value
                      trailPath: example_value
        '401':
          $ref: '#/components/responses/Unauthorized_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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:
  parameters:
    distpathParam:
      name: distpath
      in: path
      required: true
      description: Distribution path name
      schema:
        type: string
    distpathParam_2:
      name: distpath
      in: path
      required: true
      description: Name of the distribution path
      schema:
        type: string
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound_2:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse_2'
    Unauthorized_2:
      description: Authentication required or invalid credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse_2'
    BadRequest_2:
      description: Bad request - invalid parameters or request body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse_2'
  schemas:
    DistributionPath:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        status:
          type: string
          example: example_value
        source:
          type: string
          example: example_value
        target:
          type: string
          example: example_value
    CreateDistributionPathRequest:
      type: object
      required:
      - source
      - target
      properties:
        source:
          type: string
          example: example_value
        target:
          type: string
          example: example_value
    DistributionPathSummary:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        status:
          type: string
          example: example_value
        source:
          type: string
          example: example_value
        target:
          type: string
          example: example_value
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          example: 10
        message:
          type: string
          example: example_value
        severity:
          type: string
          example: example_value
    DistributionPathList:
      type: object
      properties:
        paths:
          type: array
          items:
            $ref: '#/components/schemas/DistributionPathSummary'
          example: []
    ExtractTrailList:
      type: object
      properties:
        extracts:
          type: array
          items:
            type: object
            properties:
              extractName:
                type: string
              trail:
                type: string
              trailPath:
                type: string
          example: []
    PathStatistics:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        bytesProcessed:
          type: integer
          format: int64
          example: 10
        messagesProcessed:
          type: integer
          format: int64
          example: 10
        lag:
          type: string
          example: example_value
    DistributionPath_2:
      type: object
      properties:
        name:
          type: string
          description: Distribution path name
          example: Example Title
        status:
          type: string
          enum:
          - running
          - stopped
          - error
          example: running
        source:
          type: string
          description: Source trail file
          example: example_value
        target:
          type: string
          description: Target receiver URL
          example: example_value
        targetType:
          type: string
          description: Target data type
          example: example_value
        ruleName:
          type: string
          description: Filter rule name
          example: example_value
    CreateDistributionPathRequest_2:
      type: object
      required:
      - source
      - target
      properties:
        source:
          type: string
          example: example_value
        target:
          type: string
          example: example_value
        targetType:
          type: string
          example: example_value
        ruleName:
          type: string
          example: example_value
    ErrorResponse_2:
      type: object
      properties:
        code:
          type: integer
          description: HTTP status code
          example: 10
        message:
          type: string
          description: Error message
          example: example_value
        severity:
          type: string
          description: Error severity level
          example: example_value
    UpdateDistributionPathRequest:
      type: object
      properties:
        source:
          type: string
          example: example_value
        target:
          type: string
          example: example_value
        status:
          type: string
          example: example_value
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-refined-from:
- oracle-goldengate-big-data-rest-api-openapi.yml
- oracle-goldengate-rest-api-openapi.yml