Oracle GoldenGate Veridata REST API

openapi: 3.1.0
info:
  title: Oracle GoldenGate Veridata REST 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: Compare Pairs
  description: Manage compare pairs within groups
- name: Connections
  description: Manage source and target database connections
- name: Execution
  description: Run and stop comparison jobs
- name: Groups
  description: Manage compare groups
- name: Import/Export
  description: Import and export Veridata configurations
- name: Jobs
  description: Manage and execute comparison jobs
- name: Logs
  description: Access server logs
- name: Monitoring
  description: Monitor comparison and repair statistics
- name: Profiles
  description: Manage comparison profiles
- name: Repair
  description: Repair out-of-sync data
- name: Server
  description: Server information and configuration
- name: Users
  description: User and user group management
- name: Validation
  description: Validate connections and configurations
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
  /services/configuration/connections:
    get:
      operationId: listConnections
      summary: Oracle Goldengate Retrieve All Connections
      description: Returns a list of all configured source and target database connections.
      tags:
      - Connections
      responses:
        '200':
          description: Connections listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionList'
              examples:
                Listconnections200Example:
                  summary: Default listConnections 200 response
                  x-microcks-default: true
                  value:
                    connections:
                    - id: abc123
                      name: Example Title
                      description: A sample description.
                      databaseType: Oracle
                      host: example_value
                      port: 10
                      serviceName: example_value
                      schema: example_value
                      agentHost: example_value
                      agentPort: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createConnection
      summary: Oracle Goldengate Create a Connection
      description: Creates a new database connection for use as a source or target in comparisons.
      tags:
      - Connections
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectionRequest'
            examples:
              CreateconnectionRequestExample:
                summary: Default createConnection request
                x-microcks-default: true
                value:
                  name: Example Title
                  description: A sample description.
                  databaseType: example_value
                  host: example_value
                  port: 10
                  serviceName: example_value
                  schema: example_value
                  username: example_value
                  password: example_value
                  agentHost: example_value
                  agentPort: 10
      responses:
        '201':
          description: Connection created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
              examples:
                Createconnection201Example:
                  summary: Default createConnection 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    databaseType: Oracle
                    host: example_value
                    port: 10
                    serviceName: example_value
                    schema: example_value
                    agentHost: example_value
                    agentPort: 10
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/configuration/connections/{Id}:
    get:
      operationId: getConnection
      summary: Oracle Goldengate Retrieve a Connection
      description: Returns the details of a specific database connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam'
      responses:
        '200':
          description: Connection retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
              examples:
                Getconnection200Example:
                  summary: Default getConnection 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    databaseType: Oracle
                    host: example_value
                    port: 10
                    serviceName: example_value
                    schema: example_value
                    agentHost: example_value
                    agentPort: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateConnection
      summary: Oracle Goldengate Update a Connection
      description: Updates properties of an existing database connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectionRequest'
            examples:
              UpdateconnectionRequestExample:
                summary: Default updateConnection request
                x-microcks-default: true
                value:
                  name: Example Title
                  description: A sample description.
                  host: example_value
                  port: 10
                  username: example_value
                  password: example_value
      responses:
        '200':
          description: Connection updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
              examples:
                Updateconnection200Example:
                  summary: Default updateConnection 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    databaseType: Oracle
                    host: example_value
                    port: 10
                    serviceName: example_value
                    schema: example_value
                    agentHost: example_value
                    agentPort: 10
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteConnection
      summary: Oracle Goldengate Delete a Connection
      description: Deletes a database connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam'
      responses:
        '204':
          description: Connection deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/configuration/connections/{Id}/status:
    get:
      operationId: getConnectionStatus
      summary: Oracle Goldengate Retrieve Connection Status
      description: Returns the connectivity status of a database connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam'
      responses:
        '200':
          description: Connection status retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionStatus'
              examples:
                Getconnectionstatus200Example:
                  summary: Default getConnectionStatus 200 response
                  x-microcks-default: true
                  value:
                    connectionId: '500123'
                    status: connected
                    message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/configuration/connections/{Id}/metadata:
    post:
      operationId: getConnectionMetadata
      summary: Oracle Goldengate Retrieve Connection Metadata
      description: Returns database metadata (schemas, tables, columns) for a connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetadataRequest'
            examples:
              GetconnectionmetadataRequestExample:
                summary: Default getConnectionMetadata request
                x-microcks-default: true
                value:
                  schemaPattern: example_value
                  tablePattern: example_value
      responses:
        '200':
          description: Metadata retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionMetadata'
              examples:
                Getconnectionmetadata200Example:
                  summary: Default getConnectionMetadata 200 response
                  x-microcks-default: true
                  value:
                    schemas:
                    - name: Example Title
                      tables:
                      - {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/configuration/groups:
    get:
      operationId: listGroups
      summary: Oracle Goldengate Retrieve All Compare Groups
      description: Returns a list of all compare groups configured in Veridata.
      tags:
      - Groups
      responses:
        '200':
          description: Groups listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupList'
              examples:
                Listgroups200Example:
                  summary: Default listGroups 200 response
                  x-microcks-default: true
                  value:
                    groups:
                    - id: abc123
                      name: Example Title
                      description: A sample description.
                      sourceConnectionId: '500123'
                      targetConnectionId: '500123'
                      profileId: '500123'
                      comparePairCount: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createGroup
      summary: Oracle Goldengate Create a Compare Group
      description: Creates a new compare group linking source and target connections for data comparison.
      tags:
      - Groups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGroupRequest'
            examples:
              CreategroupRequestExample:
                summary: Default createGroup request
                x-microcks-default: true
                value:
                  name: Example Title
                  description: A sample description.
                  sourceConnectionId: '500123'
                  targetConnectionId: '500123'
                  profileId: '500123'
      responses:
        '201':
          description: Group created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
              examples:
                Creategroup201Example:
                  summary: Default createGroup 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    sourceConnectionId: '500123'
                    targetConnectionId: '500123'
                    profileId: '500123'
                    comparePairCount: 10
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/configuration/groups/{Id}:
    get:
      operationId: getGroup
      summary: Oracle Goldengate Retrieve a Compare Group
      description: Returns the details of a specific compare group including its source and target connections.
      tags:
      - Groups
      parameters:
      - $ref: '#/components/parameters/groupIdParam'
      responses:
        '200':
          description: Group retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
              examples:
                Getgroup200Example:
                  summary: Default getGroup 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    sourceConnectionId: '500123'
                    targetConnectionId: '500123'
                    profileId: '500123'
                    comparePairCount: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateGroup
      summary: Oracle Goldengate Update a Compare Group
      description: Updates properties of an existing compare group.
      tags:
      - Groups
      parameters:
      - $ref: '#/components/parameters/groupIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGroupRequest'
            examples:
              UpdategroupRequestExample:
                summary: Default updateGroup request
                x-microcks-default: true
                value:
                  name: Example Title
                  description: A sample description.
                  profileId: '500123'
      responses:
        '200':
          description: Group updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
              examples:
                Updategroup200Example:
                  summary: Default updateGroup 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    sourceConnectionId: '500123'
                    targetConnectionId: '500123'
                    profileId: '500123'
                    comparePairCount: 10
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteGroup
      summary: Oracle Goldengate Delete a Compare Group
      description: Deletes a compare group and its associated compare pairs.
      tags:
      - Groups
      parameters:
      - $ref: '#/components/parameters/groupIdParam'
      responses:
        '204':
          description: Group deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/configuration/groups/clone/{Id}:
    post:
      operationId: cloneGroup
      summary: Oracle Goldengate Clone a Compare Group
      description: Creates a copy of an existing compare group including all its compare pairs.
      tags:
      - Groups
      parameters:
      - $ref: '#/components/parameters/groupIdParam'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloneGroupRequest'
            examples:
              ClonegroupRequestExample:
                summary: Default cloneGroup request
                x-microcks-default: true
                value:
                  newName: example_value
      responses:
        '201':
          description: Group cloned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
              examples:
                Clonegroup201Example:
                  summary: Default cloneGroup 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    sourceConnectionId: '500123'
                    targetConnectionId: '500123'
                    profileId: '500123'
                    comparePairCount: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/configuration/groups/validate/{Id}:
    post:
      operationId: validateGroup
      summary: Oracle Goldengate Validate a Compare Group
      description: Validates the configuration of a compare group including connection and table accessibility.
      tags:
      - Validation
      parameters:
      - $ref: '#/components/parameters/groupIdParam'
      responses:
        '200':
          description: Validation result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResult'
              examples:
                Validategroup200Example:
                  summary: Default validateGroup 200 response
                  x-microcks-default: true
                  value:
                    valid: '500123'
                    messages:
                    - severity: example_value
                      message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/configuration/cps/group/{groupId}:
    post:
      operationId: createComparePairs
      summary: Oracle Goldengate Create Compare Pairs in a Group
      description: Creates one or more compare pairs within a specific compare group.
      tags:
      - Compare Pairs
      parameters:
      - $ref: '#/components/parameters/groupIdPathParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateComparePairsRequest'
            examples:
              CreatecomparepairsRequestExample:
                summary: Default createComparePairs request
                x-microcks-default: true
                value:
                  comparePairs:
                  - sourceSchema: example_value
                    sourceTable: example_value
                    targetSchema: example_value
                    targetTable: example_value
      responses:
        '201':
          description: Compare pairs created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComparePairList'
              examples:
                Createcomparepairs201Example:
                  summary: Default createComparePairs 201 response
                  x-microcks-default: true
                  value:
                    comparePairs:
                    - id: abc123
                      groupId: '500123'
                      sourceSchema: example_value
                      sourceTable: example_value
                      targetSchema: example_value
                      targetTable: example_value
                      profileId: '500123'
                      columnMappings: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/configuration/cps/{Id}:
    get:
      operationId: getComparePair
      summary: Oracle Goldengate Retrieve a Compare Pair
      description: Returns the details of a specific compare pair including source and target table mappings.
      tags:
      - Compare Pairs
      parameters:
      - $ref: '#/components/parameters/comparePairIdParam'
      responses:
        '200':
          description: Compare pair retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComparePair'
              examples:
                Getcomparepair200Example:
                  summary: Default getComparePair 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    groupId: '500123'
                    sourceSchema: example_value
                    sourceTable: example_value
                    targetSchema: example_value
                    targetTable: example_value
                    profileId: '500123'
                    columnMappings:
                    - sourceColumn: example_value
                      targetColumn: example_value
                      dataType: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: replaceComparePair
      summary: Oracle Goldengate Replace a Compare Pair
      description: Replaces the configuration of an existing compare pair.
      tags:
      - Compare Pairs
      parameters:
      - $ref: '#/components/parameters/comparePairIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplaceComparePairRequest'
            examples:
              ReplacecomparepairRequestExample:
                summary: Default replaceComparePair request
                x-microcks-default: true
                value:
                  sourceSchema: example_value
                  sourceTable: example_value
                  targetSchema: example_value
                  targetTable: example_value
                  profileId: '500123'
      responses:
        '200':
          description: Compare pair replaced
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComparePair'
              examples:
                Replacecomparepair200Example:
                  summary: Default replaceComparePair 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    groupId: '500123'
                    sourceSchema: example_value
                    sourceTable: example_value
                    targetSchema: example_value
                    targetTable: example_value
                    profileId: '500123'
                    columnMappings:
                    - sourceColumn: example_value
                      targetColumn: example_value
                      dataType: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteComparePair
      summary: Oracle Goldengate Delete a Compare Pair
      description: Deletes a compare pair from its group.
      tags:
      - Compare Pairs
      parameters:
      - $ref: '#/components/parameters/comparePairIdParam'
      responses:
        '204':
          description: Compare pair deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/configuration/cps/{Id}/colmap:
    post:
      operationId: generateColumnMappings
      summary: Oracle Goldengate Generate Column Mapping Pairs
      description: Automatically generates column mappings between source and target tables for a compare pair.
      tags:
      - Compare Pairs
      parameters:
      - $ref: '#/components/parameters/comparePairIdParam'
      responses:
        '200':
          description: Column mappings generated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ColumnMappingList'
              examples:
                Generatecolumnmappings200Example:
                  summary: Default generateColumnMappings 200 response
                  x-microcks-default: true
                  value:
                    mappings:
                    - sourceColumn: example_value
                      targetColumn: example_value
                      dataType: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/configuration/cps/validate/{Id}:
    post:
      operationId: validateComparePair
      summary: Oracle Goldengate Validate a Compare Pair
      description: Validates the configuration of a compare pair including table and column accessibility.
      tags

# --- truncated at 32 KB (109 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-goldengate/refs/heads/main/openapi/oracle-goldengate-veridata-rest-api-openapi.yml