Oracle GoldenGate REST API

openapi: 3.1.0
info:
  title: Oracle GoldenGate REST API
  description: >-
    RESTful API for managing Oracle GoldenGate Microservices Architecture,
    including deployment configuration, extract and replicat process management,
    credentials, database connections, distribution and receiver services,
    performance metrics, and monitoring. Based on Oracle GoldenGate 21c
    Microservices Architecture REST API documentation.
  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-documentation:
  - url: https://docs.oracle.com/en/middleware/goldengate/core/21.3/oggra/index.html
    description: Oracle GoldenGate REST API Reference 21c
  - url: https://docs.oracle.com/en/database/goldengate/core/26/oggra/index.html
    description: Oracle GoldenGate REST API Reference 26ai
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
security:
- basicAuth: []
tags:
- name: Certificates
  description: Manage SSL/TLS certificates
- name: Commands
  description: Execute GoldenGate commands
- name: Configuration
  description: Manage configuration settings and files
- name: Connections
  description: Manage database connections
- name: Credentials
  description: Manage credential store domains and aliases
- name: Deployments
  description: Manage GoldenGate deployments via the Service Manager
- name: Distribution
  description: Manage distribution paths for data delivery
- name: Encryption
  description: Manage encryption keys and profiles
- name: Extracts
  description: Configure and manage Extract processes
- name: Heartbeat
  description: Manage heartbeat tables for lag monitoring
- name: Logs
  description: Access service and process logs
- name: Monitoring
  description: Performance metrics and monitoring
- name: Receiver
  description: Manage receiver/collector paths
- name: Replicats
  description: Configure and manage Replicat processes
- name: Tasks
  description: Manage automated tasks
- name: Trails
  description: Manage trail files
- name: Users
  description: User management and authorization
paths:
  /services:
    get:
      operationId: getApiVersions
      summary: Oracle Goldengate Retrieve Api Versions
      description: Returns the list of available REST API versions supported by this GoldenGate instance.
      tags:
      - Configuration
      responses:
        '200':
          description: Successfully retrieved API versions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiVersionList'
              examples:
                Getapiversions200Example:
                  summary: Default getApiVersions 200 response
                  x-microcks-default: true
                  value:
                    versions:
                    - version: example_value
                      isLatest: true
                      links:
                      - {}
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2:
    get:
      operationId: describeApiVersion
      summary: Oracle Goldengate Describe Api Version V2
      description: Returns details about the v2 REST API including available resources and metadata.
      tags:
      - Configuration
      responses:
        '200':
          description: Successfully retrieved API version details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiVersionDetails'
              examples:
                Describeapiversion200Example:
                  summary: Default describeApiVersion 200 response
                  x-microcks-default: true
                  value:
                    version: example_value
                    isLatest: true
                    lifecycle: example_value
                    links:
                    - rel: example_value
                      href: example_value
                      mediaType: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/config/summary:
    get:
      operationId: getConfigSummary
      summary: Oracle Goldengate Get Service Configuration Summary
      description: Returns a summary of the current service configuration.
      tags:
      - Configuration
      responses:
        '200':
          description: Configuration summary retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigSummary'
              examples:
                Getconfigsummary200Example:
                  summary: Default getConfigSummary 200 response
                  x-microcks-default: true
                  value:
                    serviceType: example_value
                    status: example_value
                    host: example_value
                    port: 10
                    deploymentName: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/config/health:
    get:
      operationId: getServiceHealthDetails
      summary: Oracle Goldengate Get Service Health Details
      description: Returns detailed health information for the GoldenGate service, including status of all components.
      tags:
      - Monitoring
      responses:
        '200':
          description: Service health details retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceHealthDetails'
              examples:
                Getservicehealthdetails200Example:
                  summary: Default getServiceHealthDetails 200 response
                  x-microcks-default: true
                  value:
                    healthy: true
                    services:
                    - name: Example Title
                      status: example_value
                      port: 10
                      secure: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/config/health/check:
    get:
      operationId: getServiceHealthCheck
      summary: Oracle Goldengate Get Service Health Summary Check
      description: Returns a quick health check summary indicating overall service status.
      tags:
      - Monitoring
      responses:
        '200':
          description: Health check passed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckSummary'
              examples:
                Getservicehealthcheck200Example:
                  summary: Default getServiceHealthCheck 200 response
                  x-microcks-default: true
                  value:
                    healthy: true
                    status: example_value
                    timestamp: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/deployments:
    get:
      operationId: listDeployments
      summary: Oracle Goldengate List All Deployments
      description: Returns a list of all GoldenGate deployments managed by the Service Manager.
      tags:
      - Deployments
      responses:
        '200':
          description: Successfully retrieved deployment list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentList'
              examples:
                Listdeployments200Example:
                  summary: Default listDeployments 200 response
                  x-microcks-default: true
                  value:
                    deployments:
                    - name: Example Title
                      status: example_value
                      description: A sample description.
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/deployments/{deployment}:
    get:
      operationId: getDeployment
      summary: Oracle Goldengate Retrieve a Deployment
      description: Returns the configuration details of a specific GoldenGate deployment.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentParam'
      responses:
        '200':
          description: Deployment details retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
              examples:
                Getdeployment200Example:
                  summary: Default getDeployment 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: running
                    description: A sample description.
                    oggHome: example_value
                    oggVersion: example_value
                    environmentVariables: example_value
                    services:
                    - name: Example Title
                      type: example_value
                      status: example_value
                      port: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createDeployment
      summary: Oracle Goldengate Create a Deployment
      description: Creates a new GoldenGate deployment with the specified configuration.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeploymentRequest'
            examples:
              CreatedeploymentRequestExample:
                summary: Default createDeployment request
                x-microcks-default: true
                value:
                  oggHome: example_value
                  description: A sample description.
                  environmentVariables: example_value
                  autoStart: true
      responses:
        '201':
          description: Deployment created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
              examples:
                Createdeployment201Example:
                  summary: Default createDeployment 201 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: running
                    description: A sample description.
                    oggHome: example_value
                    oggVersion: example_value
                    environmentVariables: example_value
                    services:
                    - name: Example Title
                      type: example_value
                      status: example_value
                      port: 10
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          $ref: '#/components/responses/Conflict'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateDeployment
      summary: Oracle Goldengate Update a Deployment
      description: Updates configuration properties of an existing GoldenGate deployment.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDeploymentRequest'
            examples:
              UpdatedeploymentRequestExample:
                summary: Default updateDeployment request
                x-microcks-default: true
                value:
                  description: A sample description.
                  environmentVariables: example_value
                  autoStart: true
      responses:
        '200':
          description: Deployment updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
              examples:
                Updatedeployment200Example:
                  summary: Default updateDeployment 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: running
                    description: A sample description.
                    oggHome: example_value
                    oggVersion: example_value
                    environmentVariables: example_value
                    services:
                    - name: Example Title
                      type: example_value
                      status: example_value
                      port: 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: deleteDeployment
      summary: Oracle Goldengate Remove a Deployment
      description: Removes a GoldenGate deployment and its associated services.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/deploymentParam'
      responses:
        '204':
          description: Deployment removed successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/deployments/{deployment}/services:
    get:
      operationId: listServices
      summary: Oracle Goldengate List Services for a Deployment
      description: Returns a list of all services configured within a specific deployment.
      tags: []
      parameters:
      - $ref: '#/components/parameters/deploymentParam'
      responses:
        '200':
          description: Successfully retrieved service list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceList'
              examples:
                Listservices200Example:
                  summary: Default listServices 200 response
                  x-microcks-default: true
                  value:
                    services:
                    - name: Example Title
                      type: example_value
                      status: example_value
                      port: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/deployments/{deployment}/services/{service}:
    get:
      operationId: getService
      summary: Oracle Goldengate Retrieve a Service
      description: Returns the configuration and status of a specific service within a deployment.
      tags: []
      parameters:
      - $ref: '#/components/parameters/deploymentParam'
      - $ref: '#/components/parameters/serviceParam'
      responses:
        '200':
          description: Service details retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Service'
              examples:
                Getservice200Example:
                  summary: Default getService 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    type: AdminServer
                    status: running
                    port: 10
                    secure: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createService
      summary: Oracle Goldengate Create a Service
      description: Creates a new service within a deployment.
      tags: []
      parameters:
      - $ref: '#/components/parameters/deploymentParam'
      - $ref: '#/components/parameters/serviceParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateServiceRequest'
            examples:
              CreateserviceRequestExample:
                summary: Default createService request
                x-microcks-default: true
                value:
                  type: AdminServer
                  port: 10
                  secure: true
      responses:
        '201':
          description: Service created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Service'
              examples:
                Createservice201Example:
                  summary: Default createService 201 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    type: AdminServer
                    status: running
                    port: 10
                    secure: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateService
      summary: Oracle Goldengate Update Service Properties
      description: Updates the configuration properties of an existing service.
      tags: []
      parameters:
      - $ref: '#/components/parameters/deploymentParam'
      - $ref: '#/components/parameters/serviceParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateServiceRequest'
            examples:
              UpdateserviceRequestExample:
                summary: Default updateService request
                x-microcks-default: true
                value:
                  port: 10
                  secure: true
                  status: example_value
      responses:
        '200':
          description: Service updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Service'
              examples:
                Updateservice200Example:
                  summary: Default updateService 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    type: AdminServer
                    status: running
                    port: 10
                    secure: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteService
      summary: Oracle Goldengate Remove a Service
      description: Removes a service from a deployment.
      tags: []
      parameters:
      - $ref: '#/components/parameters/deploymentParam'
      - $ref: '#/components/parameters/serviceParam'
      responses:
        '204':
          description: Service removed successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/extracts:
    get:
      operationId: listExtracts
      summary: Oracle Goldengate List All Extract Processes
      description: Returns a list of all Extract processes configured in the GoldenGate instance.
      tags:
      - Extracts
      responses:
        '200':
          description: Successfully retrieved extract list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractList'
              examples:
                Listextracts200Example:
                  summary: Default listExtracts 200 response
                  x-microcks-default: true
                  value:
                    extracts:
                    - name: Example Title
                      type: example_value
                      status: example_value
                      trail: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/extracts/{extract}:
    get:
      operationId: getExtract
      summary: Oracle Goldengate Retrieve an Extract Process
      description: Returns the configuration and current status of a specific Extract process.
      tags:
      - Extracts
      parameters:
      - $ref: '#/components/parameters/extractParam'
      responses:
        '200':
          description: Extract details retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extract'
              examples:
                Getextract200Example:
                  summary: Default getExtract 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    type: cdc
                    status: running
                    description: A sample description.
                    begin: example_value
                    trail: example_value
                    trailSize: 10
                    config:
                    - example_value
                    registration: example_value
                    credentials:
                      domain: example_value
                      alias: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createExtract
      summary: Oracle Goldengate Create an Extract Process
      description: >-
        Creates a new Extract process with the specified configuration. Supports
        initial-load, change-data-capture, and data-pump extract types.
      tags:
      - Extracts
      parameters:
      - $ref: '#/components/parameters/extractParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateExtractRequest'
            examples:
              CreateextractRequestExample:
                summary: Default createExtract request
                x-microcks-default: true
                value:
                  type: cdc
                  description: A sample description.
                  begin: example_value
                  trail: example_value
                  trailSize: 10
                  config:
                  - example_value
                  registration: example_value
                  credentials:
                    domain: example_value
                    alias: example_value
      responses:
        '201':
          description: Extract created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extract'
              examples:
                Createextract201Example:
                  summary: Default createExtract 201 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    type: cdc
                    status: running
                    description: A sample description.
                    begin: example_value
                    trail: example_value
                    trailSize: 10
                    config:
                    - example_value
                    registration: example_value
                    credentials:
                      domain: example_value
                      alias: example_value
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          $ref: '#/components/responses/Conflict'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateExtract
      summary: Oracle Goldengate Update an Extract Process
      description: Updates the configuration of an existing Extract process.
      tags:
      - Extracts
      parameters:
      - $ref: '#/components/parameters/extractParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateExtractRequest'
            examples:
              UpdateextractRequestExample:
                summary: Default updateExtract request
                x-microcks-default: true
                value:
                  description: A sample description.
                  config:
                  - example_value
                  credentials:
                    domain: example_value
                    alias: example_value
                  begin: example_value
                  status: example_value
      responses:
        '200':
          description: Extract updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extract'
              examples:
                Updateextract200Example:
                  summary: Default updateExtract 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    type: cdc
                    status: running
                    description: A sample description.
                    begin: example_value
                    trail: example_value
                    trailSize: 10
                    config:
                    - example_value
                    registration: example_value
                    credentials:
                      domain: example_value
                      alias: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteExtract
      summary: Oracle Goldengate Delete an Extract Process
      description: Deletes an Extract process and optionally its associated trail files.
      tags:
      - Extracts
      parameters:
      - $ref: '#/components/parameters/extractParam'
      responses:
        '204':
          description: Extract deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/extracts/{extract}/command:
    post:
      operationId: issueExtractCommand
      summary: Oracle Goldengate Issue a Command to an Extract
      description: >-
        Issues an operational command to an Extract process such as START, STOP,
        KILL, STATUS, STATS, LAG, or INFO.
      tags:
      - Extracts
      parameters:
      - $ref: '#/components/parameters/extractParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessCommand'
            examples:
              IssueextractcommandRequestExample:
                summary: Default issueExtractCommand request
                x-microcks-default: true
                value:
                  action: start
                  options: example_value
      responses:
        '200':
          description: Command executed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommandResponse'
              examples:
                Issueextractcommand200Example:
                  summary: Default issueExtractCommand 200 response
                  x-microcks-default: true
                  value:
                    response:
                      code: example_value
                      severity: example_value
                      message: example_value
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/extracts/{extract}/info/status:
    get:
      operationId: getExtractStatus
      summary: Oracle Goldengate Retrieve Extract Status
      description: Returns the current runtime status of an Extract process including lag, checkpoint, and position information.
      tags:
      - Extracts
      parameters:
      - $ref: '#/components/parameters/extractParam'
      responses:
        '200':
          description: Extract status retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessStatus'
              examples:
                Getextractstatus200Example:
                  summary: Default getExtractStatus 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    status: example_value
                    lag: example_value
                    checkpoint: example_value
                    since: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/extracts/{extract}/info/checkpoints:
    get:
      operationId: getExtractCheckpoints
      summary: Oracle Goldengate Retrieve Extract Checkpoints
      description: Returns checkpoint information for an Extract process.
      tags:
      - Extracts
      parameters:
      - $ref: '#/components/parameters/extractParam'
      responses:
        '200':
          description: Extract checkpoints retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Checkpoints'
              examples:
                Getextractcheckpoints200Example:
                  summary: Default getExtractCheckpoints 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    readCheckpoint:
                      sequenceNumber: 10
                      rba: 10
                      timestamp: '2026-01-15T10:30:00Z'
                    writeCheckpoint:
                      sequenceNumber: 10
                      rba: 10
                      timestamp: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/extracts/{extract}/info/reports:
    get:
      operationId: listExtractReports
      summary: Oracle Goldengate List Extract Reports
      description: Returns a list of available process reports for an Extract.
      tags:
      - Extracts
      parameters:
      - $ref: '#/components/parameters/extractParam'
      responses:
        '200':
          description: Extract reports listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportList'
              examples:
                Listextractrep

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