How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle GoldenGate Heartbeat API

Manage heartbeat tables for lag monitoring

Oracle GoldenGate Heartbeat API is one of 37 APIs that Oracle GoldenGate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Heartbeat. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, a changelog, and an API reference.

This API exposes 5 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 21.3.0.

Requests are made against a single base URL, https://{goldengate-host}:{port}.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
21.3.0
Base URL
https://:/services/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Oracle GoldenGate Heartbeat API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication with GoldenGate user credentials

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Heartbeat 5

Manage heartbeat tables for lag monitoring

GET
/services/v2/connections/{connection}/tables/heartbeat
Oracle Goldengate Retrieve Heartbeat Table Configuration
getHeartbeatTable 1 param → 200401404
POST
/services/v2/connections/{connection}/tables/heartbeat
Oracle Goldengate Create Heartbeat Table
createHeartbeatTable 1 param body → 201400401
PATCH
/services/v2/connections/{connection}/tables/heartbeat
Oracle Goldengate Update Heartbeat Table
updateHeartbeatTable 1 param body → 200401404
DELETE
/services/v2/connections/{connection}/tables/heartbeat
Oracle Goldengate Delete Heartbeat Table
deleteHeartbeatTable 1 param → 204401404
GET
/services/v2/connections/{connection}/tables/heartbeatData
Oracle Goldengate Retrieve Heartbeat Table Entries
getHeartbeatEntries 1 param → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are HeartbeatTable (5 properties), CreateHeartbeatTableRequest (4 properties), ErrorResponse (3 properties), UpdateHeartbeatTableRequest (3 properties). Each schema is shown below with its type and property counts.

HeartbeatEntries
object
1 property
UpdateHeartbeatTableRequest
object
3 properties
CreateHeartbeatTableRequest
object
4 properties
HeartbeatTable
object
5 properties
ErrorResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-goldengate-heartbeat-api-openapi.yml Raw ↑

Other APIs Oracle GoldenGate publishes across the network.

Oracle GoldenGate Artifacts API
Oracle GoldenGate AsyncAPI API
Oracle GoldenGate Certificates API
Oracle GoldenGate Commands API
Oracle GoldenGate Compare Pairs API
Oracle GoldenGate Configuration API
Oracle GoldenGate Connection Assignments API
Oracle GoldenGate Connections API
Oracle GoldenGate Credentials API
Oracle GoldenGate Data Streams API
Oracle GoldenGate Data Targets API
Oracle GoldenGate Database Registrations API
Where this information came from

This is an independent, third-party profile of Oracle GoldenGate Heartbeat API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.