Oracle GoldenGate

Oracle GoldenGate Profiles API

Manage comparison profiles

GitHub OpenAPI

Operations 6

GET /services/configuration/profiles Oracle Goldengate Retrieve All Profiles #
POST /services/configuration/profiles Oracle Goldengate Create a Profile #
GET /services/configuration/profiles/{Id} Oracle Goldengate Retrieve a Profile #
PATCH /services/configuration/profiles/{Id} Oracle Goldengate Update a Profile #
DELETE /services/configuration/profiles/{Id} Oracle Goldengate Delete a Profile #
PUT /services/configuration/profiles/{Id}/reset Oracle Goldengate Reset a Profile to Defaults #

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-profiles-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-profiles-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-profiles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Oracle GoldenGate Veridata REST Profiles 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: Profiles
  description: Manage comparison profiles
paths:
  /services/configuration/profiles:
    get:
      operationId: listProfiles
      summary: Oracle Goldengate Retrieve All Profiles
      description: Returns a list of all comparison profiles that define comparison behavior settings.
      tags:
      - Profiles
      responses:
        '200':
          description: Profiles listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileList'
              examples:
                Listprofiles200Example:
                  summary: Default listProfiles 200 response
                  x-microcks-default: true
                  value:
                    profiles:
                    - id: abc123
                      name: Example Title
                      description: A sample description.
                      comparisonMethod: row
                      maxConcurrentComparePairs: 10
                      deltaProcessing: true
                      reportOutOfSync: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createProfile
      summary: Oracle Goldengate Create a Profile
      description: Creates a new comparison profile with custom comparison settings.
      tags:
      - Profiles
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProfileRequest'
            examples:
              CreateprofileRequestExample:
                summary: Default createProfile request
                x-microcks-default: true
                value:
                  name: Example Title
                  description: A sample description.
                  comparisonMethod: row
                  maxConcurrentComparePairs: 10
                  deltaProcessing: true
      responses:
        '201':
          description: Profile created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
              examples:
                Createprofile201Example:
                  summary: Default createProfile 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    comparisonMethod: row
                    maxConcurrentComparePairs: 10
                    deltaProcessing: true
                    reportOutOfSync: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/configuration/profiles/{Id}:
    get:
      operationId: getProfile
      summary: Oracle Goldengate Retrieve a Profile
      description: Returns the details of a specific comparison profile.
      tags:
      - Profiles
      parameters:
      - $ref: '#/components/parameters/profileIdParam'
      responses:
        '200':
          description: Profile retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
              examples:
                Getprofile200Example:
                  summary: Default getProfile 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    comparisonMethod: row
                    maxConcurrentComparePairs: 10
                    deltaProcessing: true
                    reportOutOfSync: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateProfile
      summary: Oracle Goldengate Update a Profile
      description: Updates properties of an existing comparison profile.
      tags:
      - Profiles
      parameters:
      - $ref: '#/components/parameters/profileIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProfileRequest'
            examples:
              UpdateprofileRequestExample:
                summary: Default updateProfile request
                x-microcks-default: true
                value:
                  name: Example Title
                  description: A sample description.
                  comparisonMethod: example_value
                  maxConcurrentComparePairs: 10
      responses:
        '200':
          description: Profile updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
              examples:
                Updateprofile200Example:
                  summary: Default updateProfile 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    comparisonMethod: row
                    maxConcurrentComparePairs: 10
                    deltaProcessing: true
                    reportOutOfSync: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteProfile
      summary: Oracle Goldengate Delete a Profile
      description: Deletes a comparison profile.
      tags:
      - Profiles
      parameters:
      - $ref: '#/components/parameters/profileIdParam'
      responses:
        '204':
          description: Profile deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/configuration/profiles/{Id}/reset:
    put:
      operationId: resetProfile
      summary: Oracle Goldengate Reset a Profile to Defaults
      description: Resets a comparison profile to its default settings.
      tags:
      - Profiles
      parameters:
      - $ref: '#/components/parameters/profileIdParam'
      responses:
        '200':
          description: Profile reset
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
              examples:
                Resetprofile200Example:
                  summary: Default resetProfile 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    comparisonMethod: row
                    maxConcurrentComparePairs: 10
                    deltaProcessing: true
                    reportOutOfSync: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ProfileList:
      type: object
      properties:
        profiles:
          type: array
          items:
            $ref: '#/components/schemas/Profile'
          example: []
    Profile:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: abc123
        name:
          type: string
          example: Example Title
        description:
          type: string
          example: A sample description.
        comparisonMethod:
          type: string
          enum:
          - row
          - hash
          example: row
        maxConcurrentComparePairs:
          type: integer
          example: 10
        deltaProcessing:
          type: boolean
          example: true
        reportOutOfSync:
          type: boolean
          example: true
    UpdateProfileRequest:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        description:
          type: string
          example: A sample description.
        comparisonMethod:
          type: string
          example: example_value
        maxConcurrentComparePairs:
          type: integer
          example: 10
    CreateProfileRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          example: Example Title
        description:
          type: string
          example: A sample description.
        comparisonMethod:
          type: string
          enum:
          - row
          - hash
          example: row
        maxConcurrentComparePairs:
          type: integer
          example: 10
        deltaProcessing:
          type: boolean
          example: true
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          example: 10
        message:
          type: string
          example: example_value
  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'
  parameters:
    profileIdParam:
      name: Id
      in: path
      required: true
      description: Profile identifier
      schema:
        type: integer
        format: int64
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with Veridata credentials