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

Manage Extract processes for source data capture

Oracle GoldenGate Extracts 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 Extracts. 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 12 operations across 9 paths, and defines 20 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}.

12 operations 9 paths 20 schemas 1 DELETE8 GET1 PATCH2 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 Extracts API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 12

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

Extracts 12

Manage Extract processes for source data capture

GET
/services/v2/extracts
Oracle Goldengate List All Extract Processes
listExtracts → 200401
GET
/services/v2/extracts/{extract}
Oracle Goldengate Retrieve an Extract Process
getExtract 1 param → 200401404
POST
/services/v2/extracts/{extract}
Oracle Goldengate Create an Extract Process
createExtract 1 param body → 201400401
PATCH
/services/v2/extracts/{extract}
Oracle Goldengate Update an Extract Process
updateExtract 1 param body → 200401404
DELETE
/services/v2/extracts/{extract}
Oracle Goldengate Delete an Extract Process
deleteExtract 1 param → 204401404
POST
/services/v2/extracts/{extract}/command
Oracle Goldengate Issue a Command to an Extract
issueExtractCommand 1 param body → 200401404
GET
/services/v2/extracts/{extract}/info/status
Oracle Goldengate Retrieve Extract Status
getExtractStatus 1 param → 200401404
GET
/services/v2/extracts/{extract}/info/checkpoints
Oracle Goldengate Retrieve Extract Checkpoints
getExtractCheckpoints 1 param → 200401404
GET
/services/v2/extracts/{extract}/info/reports
Oracle Goldengate List Extract Reports
listExtractReports 1 param → 200401404
GET
/services/v2/extracts/{extract}/info/reports/{report}
Oracle Goldengate Retrieve a Specific Extract Report
getExtractReport 2 params → 200401404
GET
/services/v2/extracts/{extract}/info/logs
Oracle Goldengate List Extract Logs
listExtractLogs 1 param → 200401404
GET
/services/v2/extracts/{extract}/info/history
Oracle Goldengate Retrieve Extract History
getExtractHistory 1 param → 200401404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Extract_2 (10 properties), CreateExtractRequest_2 (8 properties), ProcessStatus (5 properties), UpdateExtractRequest_2 (5 properties). Each schema is shown below with its type and property counts.

CreateExtractRequest
object
4 properties 3 required
Extract
object
5 properties
UpdateExtractRequest
object
2 properties
ExtractList
object
1 property
ProcessCommand
object
1 property 1 required
ErrorResponse
object
3 properties
CommandResponse
object
1 property
ExtractSummary
object
3 properties
LogList
object
1 property
ReportList
object
1 property
ProcessHistory
object
2 properties
ProcessStatus
object
5 properties
Checkpoints
object
3 properties
UpdateExtractRequest_2
object
5 properties
ExtractSummary_2
object
4 properties
CreateExtractRequest_2
object
8 properties 3 required
Extract_2
object
10 properties
ErrorResponse_2
object
3 properties
ProcessCommand_2
object
2 properties 1 required
Report
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-goldengate-extracts-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 Extracts 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.