Oracle GoldenGate

Oracle GoldenGate Execution API

Run and stop comparison jobs

Documentation GitHub OpenAPI

Operations 2

POST /services/execution/jobs/{Id} Oracle Goldengate Run a Comparison Job #

POST /services/execution/jobs/{runId}/stop Oracle Goldengate Stop a Running Job #

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

openapi: 3.2.0
info:
  title: Oracle GoldenGate Veridata REST Execution 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: Execution
  description: Run and stop comparison jobs
paths:
  /services/execution/jobs/{Id}:
    post:
      operationId: runJob
      summary: Oracle Goldengate Run a Comparison Job
      description: Starts execution of a comparison job to compare data between source and target databases.
      tags:
      - Execution
      parameters:
      - $ref: '#/components/parameters/jobIdParam'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunJobRequest'
            examples:
              RunjobRequestExample:
                summary: Default runJob request
                x-microcks-default: true
                value:
                  profileOverrides: example_value
      responses:
        '200':
          description: Job started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobExecution'
              examples:
                Runjob200Example:
                  summary: Default runJob 200 response
                  x-microcks-default: true
                  value:
                    runId: '500123'
                    jobId: '500123'
                    status: running
                    startTime: '2026-01-15T10:30:00Z'
                    endTime: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/execution/jobs/{runId}/stop:
    post:
      operationId: stopJob
      summary: Oracle Goldengate Stop a Running Job
      description: Stops a currently running comparison job or specific compare pairs within it.
      tags:
      - Execution
      parameters:
      - $ref: '#/components/parameters/runIdParam'
      responses:
        '200':
          description: Job stopped
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobExecution'
              examples:
                Stopjob200Example:
                  summary: Default stopJob 200 response
                  x-microcks-default: true
                  value:
                    runId: '500123'
                    jobId: '500123'
                    status: running
                    startTime: '2026-01-15T10:30:00Z'
                    endTime: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    jobIdParam:
      name: Id
      in: path
      required: true
      description: Job identifier
      schema:
        type: integer
        format: int64
    runIdParam:
      name: runId
      in: path
      required: true
      description: Job or repair run identifier
      schema:
        type: integer
        format: int64
  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'
  schemas:
    RunJobRequest:
      type: object
      properties:
        profileOverrides:
          type: object
          additionalProperties: true
          example: example_value
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          example: 10
        message:
          type: string
          example: example_value
    JobExecution:
      type: object
      properties:
        runId:
          type: integer
          format: int64
          example: '500123'
        jobId:
          type: integer
          format: int64
          example: '500123'
        status:
          type: string
          enum:
          - running
          - completed
          - stopped
          - failed
          example: running
        startTime:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        endTime:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with Veridata credentials