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 Monitoring API

Performance metrics and process monitoring

Oracle GoldenGate Monitoring 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 Monitoring. 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 21 operations across 21 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://{goldengate-host}:{port}, https://{veridata-host}:{port}/veridata/v1.

21 operations 21 paths 25 schemas 1 DELETE20 GET

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 21

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

Monitoring 21

Performance metrics and process monitoring

GET
/services/v2/config/health
Oracle Goldengate Get Service Health Details
getServiceHealth → 200401
GET
/services/v2/mpoints/processes
Oracle Goldengate Retrieve All Process Metrics
listProcessMetrics → 200401
GET
/services/v2/mpoints/{item}/statisticsReplicat
Oracle Goldengate Retrieve Replicat Statistics
getReplicatStats 1 param → 200401404
GET
/services/v2/config/health/check
Oracle Goldengate Get Service Health Summary Check
getServiceHealthCheck → 200401
GET
/services/v2/mpoints/{item}/process
Oracle Goldengate Retrieve Process Metrics for a Specific Process
getProcessMetrics 1 param → 200401404
GET
/services/v2/mpoints/{item}/statisticsExtract
Oracle Goldengate Retrieve Extract Database Statistics
getExtractDatabaseStats 1 param → 200401404
GET
/services/v2/mpoints/{item}/heartbeat
Oracle Goldengate Retrieve Heartbeat Timing Metrics
getHeartbeatMetrics 1 param → 200401404
GET
/services/v2/mpoints/{item}/cacheStatistics
Oracle Goldengate Retrieve Cache Manager Statistics
getCacheStatistics 1 param → 200401404
GET
/services/v2/mpoints/{item}/processPerformance
Oracle Goldengate Retrieve Process Performance Utilization
getProcessPerformance 1 param → 200401404
GET
/services/v2/monitoring/messages
Oracle Goldengate Retrieve Process Messages
listMonitoringMessages → 200401
GET
/services/v2/monitoring/statusChanges
Oracle Goldengate Retrieve Process Status Changes
listStatusChanges → 200401
GET
/services/v2/messages
Oracle Goldengate Retrieve Administrative Messages
listMessages → 200401
GET
/services/v2/requests
Oracle Goldengate Retrieve Background Requests
listBackgroundRequests → 200401
GET
/services/v2/requests/{request}
Oracle Goldengate Retrieve Request Status
getRequestStatus 1 param → 200401404
GET
/services/v2/oggerr
Oracle Goldengate List Message Codes
listMessageCodes → 200401
GET
/services/v2/oggerr/{message}
Oracle Goldengate Retrieve Message Explanation
getMessageExplanation 1 param → 200401404
GET
/services/monitoring/jobs
Oracle Goldengate Retrieve Job Statistics
getJobStatistics → 200401
GET
/services/monitoring/cps
Oracle Goldengate Retrieve Compare Pair Statistics
getComparePairStatistics → 200401
GET
/services/oos/{runId}
Oracle Goldengate Retrieve Out-of-sync Data
getOutOfSyncData 1 param → 200401404
GET
/services/monitoring/comparison/{runId}/reports
Oracle Goldengate Retrieve Comparison Report
getComparisonReport 1 param → 200401404
DELETE
/services/purge/stats
Oracle Goldengate Purge Comparison Statistics
purgeStatistics → 204401

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are ProcessMetrics (8 properties), DatabaseStatistics (6 properties), ComparisonReport (6 properties), ReplicatStatistics (6 properties). Each schema is shown below with its type and property counts.

ReplicatStatistics
object
6 properties
ErrorResponse
object
3 properties
ServiceHealth
object
2 properties
ProcessMetricsList
object
1 property
MessageList
object
1 property
MessageExplanation
object
4 properties
StatusChangeList
object
1 property
ProcessPerformance
object
4 properties
ProcessMetricsList_2
object
1 property
MonitoringMessageList
object
1 property
CacheStatistics
object
4 properties
HealthCheckSummary
object
3 properties
RequestList
object
1 property
ProcessMetrics
object
8 properties
MessageCodeList
object
1 property
RequestStatus
object
5 properties
ErrorResponse_2
object
3 properties
DatabaseStatistics
object
6 properties
HeartbeatMetrics
object
3 properties
ServiceHealthDetails
object
2 properties
ComparePairStatisticsList
object
1 property
OutOfSyncData
object
2 properties
ErrorResponse_3
object
2 properties
ComparisonReport
object
6 properties
JobStatisticsList
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-goldengate-monitoring-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 Monitoring 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.