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

Manage data replication pipelines

Oracle GoldenGate Pipelines 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 Pipelines. 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 11 operations across 8 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://goldengate.{region}.oci.oraclecloud.com, https://{ggsa-host}:{port}/osa.

11 operations 8 paths 14 schemas 1 DELETE4 GET2 PATCH3 POST1 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 Pipelines 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 GGSA credentials

Paths & Operations 11

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

Pipelines 11

Manage data replication pipelines

GET
/20200407/pipelines
Oracle Goldengate List Pipelines
listPipelines 3 params → 200
POST
/20200407/pipelines
Oracle Goldengate Create a Pipeline
createPipeline body → 200
GET
/20200407/pipelines/{pipelineId}
Oracle Goldengate Get a Pipeline
getPipeline 1 param → 200404
PUT
/20200407/pipelines/{pipelineId}
Oracle Goldengate Update a Pipeline
updatePipeline 2 params body → 200404
DELETE
/20200407/pipelines/{pipelineId}
Oracle Goldengate Delete a Pipeline
deletePipeline 2 params → 202404
POST
/20200407/pipelines/{pipelineId}/actions/start
Oracle Goldengate Start a Pipeline
startPipeline 2 params → 202
POST
/20200407/pipelines/{pipelineId}/actions/stop
Oracle Goldengate Stop a Pipeline
stopPipeline 2 params → 202
GET
/services/v1/pipelines
Oracle Goldengate List Pipelines
listPipelines → 200401
GET
/services/v1/pipelines/{id}/export
Oracle Goldengate Export a Pipeline
exportPipeline 1 param → 200401404
PATCH
/services/v1/pipelines/{id}/publish
Oracle Goldengate Publish a Pipeline
publishPipeline 1 param body → 200400401404
PATCH
/services/v1/pipelines/{id}/unpublish
Oracle Goldengate Unpublish a Pipeline
unpublishPipeline 1 param → 200401404

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Pipeline_2 (10 properties), Pipeline (9 properties), CreatePipelineDetails (5 properties), PipelineExport (4 properties). Each schema is shown below with its type and property counts.

Error
object
2 properties
Pipeline
object
9 properties
PipelineSummary
object
4 properties
PipelineCollection
object
1 property
CreatePipelineDetails
object
5 properties 2 required
UpdatePipelineDetails
object
2 properties
PipelineSource
object
4 properties
Pipeline_2
object
10 properties
PipelineExport
object
Complete pipeline export including all dependencies (sources, targets, connections, references, predictive models, geo fences, visualizations, and custom jars)
4 properties
PipelineList
object
1 property
PipelineStage
object
4 properties
PipelineTarget
object
4 properties
ErrorResponse
object
2 properties
PublishPipelineRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-goldengate-pipelines-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 Pipelines 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.