Oracle GoldenGate Logs API

Access service and process logs

Operations 5

GET /services/v2/logs Oracle Goldengate Retrieve Available Logs #
GET /services/v2/logs/{log} Oracle Goldengate Retrieve a Log File #
PATCH /services/v2/logs/{log} Oracle Goldengate Modify Log Properties #
GET /services/v2/logs/events Oracle Goldengate Get Critical Events #
GET /services/logs/server Oracle Goldengate Retrieve Server Logs #

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

Other Resources

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-logs-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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

oracle-goldengate-logs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Oracle Goldengate Logs API
  contact:
    name: Oracle Support
    url: https://support.oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/legal/terms.html
  x-refined-note:
  - x-documentation differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Logs across 2 of this provider''s published API definitions: oracle-goldengate-rest-api-openapi.yml, oracle-goldengate-veridata-rest-api-openapi.yml. Each path carries the servers of the definition it was published in.'
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
- 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: Logs
  description: Access service and process logs
paths:
  /services/v2/logs:
    get:
      operationId: listLogs
      summary: Oracle Goldengate Retrieve Available Logs
      description: Returns a list of available service log files.
      tags:
      - Logs
      responses:
        '200':
          description: Logs listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogList'
              examples:
                Listlogs200Example:
                  summary: Default listLogs 200 response
                  x-microcks-default: true
                  value:
                    logs:
                    - name: Example Title
                      size: 10
                      lastModified: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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
  /services/v2/logs/{log}:
    get:
      operationId: getLog
      summary: Oracle Goldengate Retrieve a Log File
      description: Returns the content of a specific service log file.
      tags:
      - Logs
      parameters:
      - name: log
        in: path
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Log content retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogContent'
              examples:
                Getlog200Example:
                  summary: Default getLog 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    content: example_value
                    size: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: modifyLogProperties
      summary: Oracle Goldengate Modify Log Properties
      description: Modifies the properties of a log such as log level.
      tags:
      - Logs
      parameters:
      - name: log
        in: path
        required: true
        schema:
          type: string
        example: example_value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyLogRequest'
            examples:
              ModifylogpropertiesRequestExample:
                summary: Default modifyLogProperties request
                x-microcks-default: true
                value:
                  level: ERROR
      responses:
        '200':
          description: Log properties updated
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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
  /services/v2/logs/events:
    get:
      operationId: getCriticalEvents
      summary: Oracle Goldengate Get Critical Events
      description: Returns critical event log entries.
      tags:
      - Logs
      responses:
        '200':
          description: Critical events retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventList'
              examples:
                Getcriticalevents200Example:
                  summary: Default getCriticalEvents 200 response
                  x-microcks-default: true
                  value:
                    events:
                    - timestamp: '2026-01-15T10:30:00Z'
                      severity: example_value
                      source: example_value
                      message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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
  /services/logs/server:
    get:
      operationId: getServerLogs
      summary: Oracle Goldengate Retrieve Server Logs
      description: Returns server log entries.
      tags:
      - Logs
      parameters:
      - name: logType
        in: query
        schema:
          type: string
          enum:
          - api
          - perf
          - both
        example: api
      - name: logLevel
        in: query
        schema:
          type: string
          enum:
          - ERROR
          - WARNING
          - INFO
          - DEBUG
        example: ERROR
      - name: lastLines
        in: query
        schema:
          type: integer
        example: 10
      responses:
        '200':
          description: Logs retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerLogs'
              examples:
                Getserverlogs200Example:
                  summary: Default getServerLogs 200 response
                  x-microcks-default: true
                  value:
                    entries:
                    - timestamp: '2026-01-15T10:30:00Z'
                      level: example_value
                      message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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
components:
  schemas:
    LogList:
      type: object
      properties:
        logs:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              size:
                type: integer
              lastModified:
                type: string
                format: date-time
          example: []
    LogContent:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        content:
          type: string
          example: example_value
        size:
          type: integer
          example: 10
    ModifyLogRequest:
      type: object
      properties:
        level:
          type: string
          enum:
          - ERROR
          - WARNING
          - INFO
          - DEBUG
          example: ERROR
    EventList:
      type: object
      properties:
        events:
          type: array
          items:
            type: object
            properties:
              timestamp:
                type: string
                format: date-time
              severity:
                type: string
              source:
                type: string
              message:
                type: string
          example: []
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          description: HTTP status code
          example: 10
        message:
          type: string
          description: Error message
          example: example_value
        severity:
          type: string
          description: Error severity level
          example: example_value
    ErrorResponse_2:
      type: object
      properties:
        code:
          type: integer
          example: 10
        message:
          type: string
          example: example_value
    ServerLogs:
      type: object
      properties:
        entries:
          type: array
          items:
            type: object
            properties:
              timestamp:
                type: string
                format: date-time
              level:
                type: string
              message:
                type: string
          example: []
  responses:
    NotFound:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required or invalid credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized_2:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse_2'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with GoldenGate user credentials
x-refined-from:
- oracle-goldengate-rest-api-openapi.yml
- oracle-goldengate-veridata-rest-api-openapi.yml