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

Manage database and service connections

Oracle GoldenGate Connections 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 Connections. 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 12 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://goldengate.{region}.oci.oraclecloud.com, https://{goldengate-host}:{port}, https://{veridata-host}:{port}/veridata/v1.

21 operations 12 paths 22 schemas 3 DELETE9 GET1 PATCH6 POST2 PUT

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 Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

Oracle GoldenGate Connections API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (ociSignature). It accepts HTTP basic authentication (basicAuth).

  • ociSignature — OCI API request signature (RFC 7616) or bearer token authentication
  • basicAuth — HTTP Basic authentication with GoldenGate user credentials

Paths & Operations 21

Across 12 paths, the API surfaces 21 operations — 3 DELETE, 9 GET, 1 PATCH, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Connections 21

Manage database and service connections

GET
/20200407/connections
Oracle Goldengate List Connections
listConnections 4 params → 200
POST
/20200407/connections
Oracle Goldengate Create a Connection
createConnection body → 200400
GET
/20200407/connections/{connectionId}
Oracle Goldengate Get a Connection
getConnection 1 param → 200404
PUT
/20200407/connections/{connectionId}
Oracle Goldengate Update a Connection
updateConnection 2 params body → 200404
DELETE
/20200407/connections/{connectionId}
Oracle Goldengate Delete a Connection
deleteConnection 2 params → 202404
GET
/services/v2/connections
Oracle Goldengate List Database Connections
listConnections → 200401
GET
/services/v2/connections/{connection}
Oracle Goldengate Retrieve a Database Connection
getConnection 1 param → 200401404
POST
/services/v2/connections/{connection}
Oracle Goldengate Create a Database Connection
createConnection 1 param body → 201400401
PUT
/services/v2/connections/{connection}
Oracle Goldengate Replace a Database Connection
replaceConnection 1 param body → 200401404
DELETE
/services/v2/connections/{connection}
Oracle Goldengate Delete a Database Connection
deleteConnection 1 param → 204401404
POST
/services/v2/connections/{connection}/trandata/table
Oracle Goldengate Manage Table Supplemental Logging
manageTableSupplementalLogging 1 param body → 200400401
POST
/services/v2/connections/{connection}/trandata/schema
Oracle Goldengate Manage Schema Supplemental Logging
manageSchemaSupplementalLogging 1 param body → 200400401
GET
/services/v2/connections/{connection}/databases
Oracle Goldengate Retrieve Database Names
getDatabaseNames 1 param → 200401404
GET
/services/v2/connections/{connection}/databases/{database}/{schema}
Oracle Goldengate Retrieve Database Tables
getDatabaseTables 3 params → 200401404
GET
/services/configuration/connections
Oracle Goldengate Retrieve All Connections
listConnections → 200401
POST
/services/configuration/connections
Oracle Goldengate Create a Connection
createConnection body → 201400401
GET
/services/configuration/connections/{Id}
Oracle Goldengate Retrieve a Connection
getConnection 1 param → 200401404
PATCH
/services/configuration/connections/{Id}
Oracle Goldengate Update a Connection
updateConnection 1 param body → 200400401404
DELETE
/services/configuration/connections/{Id}
Oracle Goldengate Delete a Connection
deleteConnection 1 param → 204401404
GET
/services/configuration/connections/{Id}/status
Oracle Goldengate Retrieve Connection Status
getConnectionStatus 1 param → 200401404
POST
/services/configuration/connections/{Id}/metadata
Oracle Goldengate Retrieve Connection Metadata
getConnectionMetadata 1 param body → 200401404

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are CreateConnectionRequest_2 (11 properties), Connection_2 (10 properties), Connection (10 properties), CreateConnectionDetails (6 properties). Each schema is shown below with its type and property counts.

UpdateConnectionDetails
object
3 properties
Error
object
2 properties
CreateConnectionDetails
object
6 properties 4 required
ConnectionSummary
object
5 properties
ConnectionCollection
object
1 property
Connection
object
10 properties
TrandataRequest
object
2 properties 1 required
DatabaseConnection
object
4 properties
CreateConnectionRequest
object
3 properties 1 required
ConnectionList
object
1 property
TableList
object
1 property
ErrorResponse
object
3 properties
DatabaseNameList
object
1 property
TrandataResponse
object
2 properties
ConnectionStatus
object
3 properties
UpdateConnectionRequest
object
6 properties
CreateConnectionRequest_2
object
11 properties 4 required
MetadataRequest
object
2 properties
ConnectionList_2
object
1 property
ErrorResponse_2
object
2 properties
ConnectionMetadata
object
1 property
Connection_2
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-goldengate-connections-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 Credentials API
Oracle GoldenGate Data Streams API
Oracle GoldenGate Data Targets API
Oracle GoldenGate Database Registrations API
Oracle GoldenGate Deployment Backups API
Where this information came from

This is an independent, third-party profile of Oracle GoldenGate Connections 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.