Oracle GoldenGate

Oracle GoldenGate Server API

Server information and configuration

GitHub OpenAPI

Operations 7

GET /services/server/info Oracle Goldengate Retrieve Server Details #
GET /services/server/configuration Oracle Goldengate Retrieve Server Configurations #
PATCH /services/server/configuration Oracle Goldengate Update Server Configurations #
PUT /services/server/configuration/reset Oracle Goldengate Reset Server Configurations to Default #
GET /auth/login Oracle Goldengate Login to Veridata #
GET /session/extend Oracle Goldengate Extend User Session #
GET /session/invalidate Oracle Goldengate Invalidate Session (logout) #

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-server-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-server-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-server-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Oracle GoldenGate Veridata REST Server API
  description: REST API for Oracle GoldenGate Veridata, a data comparison and repair solution that verifies data consistency between source and target databases. Provides operations for managing connections, compare groups, compare pairs, jobs, profiles, monitoring comparison results, and repairing out-of-sync data. Based on Oracle GoldenGate Veridata 23c REST API documentation.
  version: '1.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-documentation:
  - url: https://docs.oracle.com/en/middleware/goldengate/veridata/23/ggvra/rest-endpoints.html
    description: Oracle GoldenGate Veridata REST API Reference
servers:
- url: https://{veridata-host}:{port}/veridata/v1
  description: Oracle GoldenGate Veridata server
  variables:
    veridata-host:
      default: localhost
      description: Veridata server host
    port:
      default: '8830'
      description: Veridata HTTPS port
security:
- basicAuth: []
tags:
- name: Server
  description: Server information and configuration
paths:
  /services/server/info:
    get:
      operationId: getServerInfo
      summary: Oracle Goldengate Retrieve Server Details
      description: Returns server information including version, uptime, and system details.
      tags:
      - Server
      responses:
        '200':
          description: Server information retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerInfo'
              examples:
                Getserverinfo200Example:
                  summary: Default getServerInfo 200 response
                  x-microcks-default: true
                  value:
                    version: example_value
                    buildNumber: example_value
                    uptime: example_value
                    javaVersion: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/server/configuration:
    get:
      operationId: getServerConfiguration
      summary: Oracle Goldengate Retrieve Server Configurations
      description: Returns the current server configuration settings.
      tags:
      - Server
      responses:
        '200':
          description: Configuration retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerConfiguration'
              examples:
                Getserverconfiguration200Example:
                  summary: Default getServerConfiguration 200 response
                  x-microcks-default: true
                  value:
                    maxConcurrentJobs: 10
                    maxThreadsPerJob: 10
                    reportRetentionDays: 10
                    oosRetentionDays: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateServerConfiguration
      summary: Oracle Goldengate Update Server Configurations
      description: Updates server configuration settings.
      tags:
      - Server
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateServerConfigurationRequest'
            examples:
              UpdateserverconfigurationRequestExample:
                summary: Default updateServerConfiguration request
                x-microcks-default: true
                value:
                  maxConcurrentJobs: 10
                  maxThreadsPerJob: 10
                  reportRetentionDays: 10
      responses:
        '200':
          description: Configuration updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerConfiguration'
              examples:
                Updateserverconfiguration200Example:
                  summary: Default updateServerConfiguration 200 response
                  x-microcks-default: true
                  value:
                    maxConcurrentJobs: 10
                    maxThreadsPerJob: 10
                    reportRetentionDays: 10
                    oosRetentionDays: 10
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/server/configuration/reset:
    put:
      operationId: resetServerConfiguration
      summary: Oracle Goldengate Reset Server Configurations to Default
      description: Resets all server configuration settings to their factory default values.
      tags:
      - Server
      responses:
        '200':
          description: Configuration reset to defaults
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerConfiguration'
              examples:
                Resetserverconfiguration200Example:
                  summary: Default resetServerConfiguration 200 response
                  x-microcks-default: true
                  value:
                    maxConcurrentJobs: 10
                    maxThreadsPerJob: 10
                    reportRetentionDays: 10
                    oosRetentionDays: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /auth/login:
    get:
      operationId: login
      summary: Oracle Goldengate Login to Veridata
      description: Authenticates a user and establishes a session.
      tags:
      - Server
      security: []
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Login successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginResponse'
              examples:
                Login200Example:
                  summary: Default login 200 response
                  x-microcks-default: true
                  value:
                    token: example_value
                    sessionTimeout: 10
                    username: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /session/extend:
    get:
      operationId: extendSession
      summary: Oracle Goldengate Extend User Session
      description: Extends the current user session timeout.
      tags:
      - Server
      responses:
        '200':
          description: Session extended
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /session/invalidate:
    get:
      operationId: invalidateSession
      summary: Oracle Goldengate Invalidate Session (logout)
      description: Invalidates the current user session.
      tags:
      - Server
      responses:
        '200':
          description: Session invalidated
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ServerInfo:
      type: object
      properties:
        version:
          type: string
          example: example_value
        buildNumber:
          type: string
          example: example_value
        uptime:
          type: string
          example: example_value
        javaVersion:
          type: string
          example: example_value
    UpdateServerConfigurationRequest:
      type: object
      properties:
        maxConcurrentJobs:
          type: integer
          example: 10
        maxThreadsPerJob:
          type: integer
          example: 10
        reportRetentionDays:
          type: integer
          example: 10
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          example: 10
        message:
          type: string
          example: example_value
    LoginResponse:
      type: object
      properties:
        token:
          type: string
          example: example_value
        sessionTimeout:
          type: integer
          example: 10
        username:
          type: string
          example: example_value
    ServerConfiguration:
      type: object
      properties:
        maxConcurrentJobs:
          type: integer
          example: 10
        maxThreadsPerJob:
          type: integer
          example: 10
        reportRetentionDays:
          type: integer
          example: 10
        oosRetentionDays:
          type: integer
          example: 10
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with Veridata credentials