Oracle GoldenGate

Oracle GoldenGate Heartbeat API

Manage heartbeat tables for lag monitoring

GitHub OpenAPI

Operations 5

GET /services/v2/connections/{connection}/tables/heartbeat Oracle Goldengate Retrieve Heartbeat Table Configuration #
POST /services/v2/connections/{connection}/tables/heartbeat Oracle Goldengate Create Heartbeat Table #
PATCH /services/v2/connections/{connection}/tables/heartbeat Oracle Goldengate Update Heartbeat Table #
DELETE /services/v2/connections/{connection}/tables/heartbeat Oracle Goldengate Delete Heartbeat Table #
GET /services/v2/connections/{connection}/tables/heartbeatData Oracle Goldengate Retrieve Heartbeat Table Entries #

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-heartbeat-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-heartbeat-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-heartbeat-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Oracle GoldenGate REST Heartbeat 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: Heartbeat
  description: Manage heartbeat tables for lag monitoring
paths:
  /services/v2/connections/{connection}/tables/heartbeat:
    get:
      operationId: getHeartbeatTable
      summary: Oracle Goldengate Retrieve Heartbeat Table Configuration
      description: Returns the heartbeat table configuration for a database connection.
      tags:
      - Heartbeat
      parameters:
      - $ref: '#/components/parameters/connectionParam'
      responses:
        '200':
          description: Heartbeat table configuration retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HeartbeatTable'
              examples:
                Getheartbeattable200Example:
                  summary: Default getHeartbeatTable 200 response
                  x-microcks-default: true
                  value:
                    owner: example_value
                    table: example_value
                    retentionTime: 10
                    frequency: 10
                    purgeFrequency: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createHeartbeatTable
      summary: Oracle Goldengate Create Heartbeat Table
      description: Creates the heartbeat table in the target database for lag monitoring.
      tags:
      - Heartbeat
      parameters:
      - $ref: '#/components/parameters/connectionParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateHeartbeatTableRequest'
            examples:
              CreateheartbeattableRequestExample:
                summary: Default createHeartbeatTable request
                x-microcks-default: true
                value:
                  owner: example_value
                  retentionTime: 10
                  frequency: 10
                  purgeFrequency: 10
      responses:
        '201':
          description: Heartbeat table created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HeartbeatTable'
              examples:
                Createheartbeattable201Example:
                  summary: Default createHeartbeatTable 201 response
                  x-microcks-default: true
                  value:
                    owner: example_value
                    table: example_value
                    retentionTime: 10
                    frequency: 10
                    purgeFrequency: 10
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateHeartbeatTable
      summary: Oracle Goldengate Update Heartbeat Table
      description: Updates the heartbeat table configuration.
      tags:
      - Heartbeat
      parameters:
      - $ref: '#/components/parameters/connectionParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateHeartbeatTableRequest'
            examples:
              UpdateheartbeattableRequestExample:
                summary: Default updateHeartbeatTable request
                x-microcks-default: true
                value:
                  retentionTime: 10
                  frequency: 10
                  purgeFrequency: 10
      responses:
        '200':
          description: Heartbeat table updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HeartbeatTable'
              examples:
                Updateheartbeattable200Example:
                  summary: Default updateHeartbeatTable 200 response
                  x-microcks-default: true
                  value:
                    owner: example_value
                    table: example_value
                    retentionTime: 10
                    frequency: 10
                    purgeFrequency: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteHeartbeatTable
      summary: Oracle Goldengate Delete Heartbeat Table
      description: Deletes the heartbeat table from the database.
      tags:
      - Heartbeat
      parameters:
      - $ref: '#/components/parameters/connectionParam'
      responses:
        '204':
          description: Heartbeat table deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/connections/{connection}/tables/heartbeatData:
    get:
      operationId: getHeartbeatEntries
      summary: Oracle Goldengate Retrieve Heartbeat Table Entries
      description: Returns the heartbeat data entries showing lag information across processes.
      tags:
      - Heartbeat
      parameters:
      - $ref: '#/components/parameters/connectionParam'
      responses:
        '200':
          description: Heartbeat entries retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HeartbeatEntries'
              examples:
                Getheartbeatentries200Example:
                  summary: Default getHeartbeatEntries 200 response
                  x-microcks-default: true
                  value:
                    entries:
                    - sourceProcess: example_value
                      targetProcess: example_value
                      lastHeartbeatSent: '2026-01-15T10:30:00Z'
                      lastHeartbeatReceived: '2026-01-15T10:30:00Z'
                      lagInSeconds: 42.5
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    HeartbeatEntries:
      type: object
      properties:
        entries:
          type: array
          items:
            type: object
            properties:
              sourceProcess:
                type: string
              targetProcess:
                type: string
              lastHeartbeatSent:
                type: string
                format: date-time
              lastHeartbeatReceived:
                type: string
                format: date-time
              lagInSeconds:
                type: number
          example: []
    UpdateHeartbeatTableRequest:
      type: object
      properties:
        retentionTime:
          type: integer
          example: 10
        frequency:
          type: integer
          example: 10
        purgeFrequency:
          type: integer
          example: 10
    CreateHeartbeatTableRequest:
      type: object
      properties:
        owner:
          type: string
          example: example_value
        retentionTime:
          type: integer
          example: 10
        frequency:
          type: integer
          example: 10
        purgeFrequency:
          type: integer
          example: 10
    HeartbeatTable:
      type: object
      properties:
        owner:
          type: string
          description: Schema owner of the heartbeat table
          example: example_value
        table:
          type: string
          description: Heartbeat table name
          example: example_value
        retentionTime:
          type: integer
          description: Retention time in days
          example: 10
        frequency:
          type: integer
          description: Update frequency in seconds
          example: 10
        purgeFrequency:
          type: integer
          description: Purge frequency in minutes
          example: 10
    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
  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'
    BadRequest:
      description: Bad request - invalid parameters or request body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    connectionParam:
      name: connection
      in: path
      required: true
      description: Name of the database connection
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with GoldenGate user credentials