Oracle GoldenGate 19c Microservices Architecture REST API

All REST Endpoints

Administrative Server/Commands

The operations from the Administrative Server/Commands category.

Execute Command: Method: post
Path: /services/{version}/commands/execute

Administrative Server/Configuration Settings

The operations from the Administrative Server/Configuration Settings category.

Create Configuration Data Type: Method: post
Path: /services/{version}/config/types/{type}
Create Configuration File: Method: post
Path: /services/{version}/config/files/{file}
Create Configuration Value: Method: post
Path: /services/{version}/config/types/{type}/values/{value}
Delete Configuration Data Type: Method: delete
Path: /services/{version}/config/types/{type}
Delete Configuration File: Method: delete
Path: /services/{version}/config/files/{file}
Delete Configuration Value: Method: delete
Path: /services/{version}/config/types/{type}/values/{value}
List Configuration Data Types: Method: get
Path: /services/{version}/config/types
List Configuration Files: Method: get
Path: /services/{version}/config/files
List Configuration Values: Method: get
Path: /services/{version}/config/types/{type}/values
Replace Configuration File: Method: put
Path: /services/{version}/config/files/{file}
Replace Configuration Value: Method: put
Path: /services/{version}/config/types/{type}/values/{value}
Retrieve Configuration Data Type: Method: get
Path: /services/{version}/config/types/{type}
Retrieve Configuration File: Method: get
Path: /services/{version}/config/files/{file}
Retrieve Configuration Value: Method: get
Path: /services/{version}/config/types/{type}/values/{value}

Administrative Server/Credentials

The operations from the Administrative Server/Credentials category.

Create Alias: Method: post
Path: /services/{version}/credentials/{domain}/{alias}
Delete Alias: Method: delete
Path: /services/{version}/credentials/{domain}/{alias}
List Domain Aliases: Method: get
Path: /services/{version}/credentials/{domain}
List Domains: Method: get
Path: /services/{version}/credentials
Replace Alias: Method: put
Path: /services/{version}/credentials/{domain}/{alias}
Retrieve Alias: Method: get
Path: /services/{version}/credentials/{domain}/{alias}
Validate: Method: get
Path: /services/{version}/credentials/{domain}/{alias}/valid

Administrative Server/Database

The operations from the Administrative Server/Database category.

Create Connection: Method: post
Path: /services/{version}/connections/{connection}
Create Heartbeat Table: Method: post
Path: /services/{version}/connections/{connection}/tables/heartbeat
Delete Connection: Method: delete
Path: /services/{version}/connections/{connection}
Delete Heartbeat Table: Method: delete
Path: /services/{version}/connections/{connection}/tables/heartbeat
Delete Process Heartbeat Records: Method: delete
Path: /services/{version}/connections/{connection}/tables/heartbeat/{process}
List Connections: Method: get
Path: /services/{version}/connections
Manage Checkpoint Tables: Method: post
Path: /services/{version}/connections/{connection}/tables/checkpoint
Manage Instantiation CSN: Method: post
Path: /services/{version}/connections/{connection}/databases/{database}/{schema}/{table}/instantiationCsn
Manage Procedural Supplemental Logging: Method: post
Path: /services/{version}/connections/{connection}/trandata/procedure
Manage Schema Supplemental Logging: Method: post
Path: /services/{version}/connections/{connection}/trandata/schema
Manage Table Supplemental Logging: Method: post
Path: /services/{version}/connections/{connection}/trandata/table
Manage Trace Tables: Method: post
Path: /services/{version}/connections/{connection}/tables/trace
Replace Connection: Method: put
Path: /services/{version}/connections/{connection}
Retrieve Active Transaction Details: Method: get
Path: /services/{version}/connections/{connection}/activeTransactions
Retrieve Connection: Method: get
Path: /services/{version}/connections/{connection}
Retrieve Database Names: Method: get
Path: /services/{version}/connections/{connection}/databases
Retrieve Database Schemas: Method: get
Path: /services/{version}/connections/{connection}/databases/{database}
Retrieve Database Table Details: Method: get
Path: /services/{version}/connections/{connection}/databases/{database}/{schema}/{table}
Retrieve Database Tables: Method: get
Path: /services/{version}/connections/{connection}/databases/{database}/{schema}
Retrieve Heartbeat Table: Method: get
Path: /services/{version}/connections/{connection}/tables/heartbeat
Retrieve Process Heartbeat Records: Method: get
Path: /services/{version}/connections/{connection}/tables/heartbeat/{process}
Update Heartbeat Table: Method: patch
Path: /services/{version}/connections/{connection}/tables/heartbeat

Administrative Server/Encryption Keys

The operations from the Administrative Server/Encryption Keys category.

Create Encryption Key: Method: post
Path: /services/{version}/enckeys/{keyName}
Delete Encryption Key: Method: delete
Path: /services/{version}/enckeys/{keyName}
Encrypt Data: Method: post
Path: /services/{version}/enckeys/{keyName}/encrypt
List Encryption Keys: Method: get
Path: /services/{version}/enckeys
Retrieve Encryption Key: Method: get
Path: /services/{version}/enckeys/{keyName}

Administrative Server/Extracts

The operations from the Administrative Server/Extracts category.

Create Extract: Method: post
Path: /services/{version}/extracts/{extract}
Delete Extract: Method: delete
Path: /services/{version}/extracts/{extract}
Issue Command: Method: post
Path: /services/{version}/extracts/{extract}/command
List Extracts: Method: get
Path: /services/{version}/extracts
List Information Types: Method: get
Path: /services/{version}/extracts/{extract}/info
List Reports: Method: get
Path: /services/{version}/extracts/{extract}/info/reports
Retrieve Checkpoints: Method: get
Path: /services/{version}/extracts/{extract}/info/checkpoints
Retrieve Extract: Method: get
Path: /services/{version}/extracts/{extract}
Retrieve History: Method: get
Path: /services/{version}/extracts/{extract}/info/history
Retrieve Report: Method: get
Path: /services/{version}/extracts/{extract}/info/reports/{report}
Retrieve Status: Method: get
Path: /services/{version}/extracts/{extract}/info/status
Update Extract: Method: patch
Path: /services/{version}/extracts/{extract}

Administrative Server/Logs

The operations from the Administrative Server/Logs category.

Critical Events: Method: get
Path: /services/{version}/logs/events
List Replication Logs: Method: get
Path: /services/{version}/logs

Administrative Server/Master Keys

The operations from the Administrative Server/Master Keys category.

Create Version: Method: post
Path: /services/{version}/masterkey
Delete Version: Method: delete
Path: /services/{version}/masterkey/{keyVersion}
List Versions: Method: get
Path: /services/{version}/masterkey
Retrieve Version: Method: get
Path: /services/{version}/masterkey/{keyVersion}
Update Version: Method: patch
Path: /services/{version}/masterkey/{keyVersion}

Administrative Server/Messages

The operations from the Administrative Server/Messages category.

Retrieve Messages: Method: get
Path: /services/{version}/messages

Administrative Server/Parameters

The operations from the Administrative Server/Parameters category.

List Parameter Names: Method: get
Path: /services/{version}/parameters
Retrieve Parameter Info: Method: get
Path: /services/{version}/parameters/{parameter}

Administrative Server/Replicats

The operations from the Administrative Server/Replicats category.

Create Replicat: Method: post
Path: /services/{version}/replicats/{replicat}
Delete Replicat: Method: delete
Path: /services/{version}/replicats/{replicat}
Issue Command: Method: post
Path: /services/{version}/replicats/{replicat}/command
List Information Types: Method: get
Path: /services/{version}/replicats/{replicat}/info
List Replicats: Method: get
Path: /services/{version}/replicats
List Reports: Method: get
Path: /services/{version}/replicats/{replicat}/info/reports
Retrieve Checkpoints: Method: get
Path: /services/{version}/replicats/{replicat}/info/checkpoints
Retrieve History: Method: get
Path: /services/{version}/replicats/{replicat}/info/history
Retrieve Replicat: Method: get
Path: /services/{version}/replicats/{replicat}
Retrieve Report: Method: get
Path: /services/{version}/replicats/{replicat}/info/reports/{report}
Retrieve Status: Method: get
Path: /services/{version}/replicats/{replicat}/info/status
Update Replicat: Method: patch
Path: /services/{version}/replicats/{replicat}

Administrative Server/Tasks

The operations from the Administrative Server/Tasks category.

Create Task: Method: post
Path: /services/{version}/tasks/{task}
Delete Task: Method: delete
Path: /services/{version}/tasks/{task}
List Information Types: Method: get
Path: /services/{version}/tasks/{task}/info
List Tasks: Method: get
Path: /services/{version}/tasks
Retrieve Task: Method: get
Path: /services/{version}/tasks/{task}
Retrieve Task History: Method: get
Path: /services/{version}/tasks/{task}/info/history
Retrieve Task Status: Method: get
Path: /services/{version}/tasks/{task}/info/status
Update Task: Method: patch
Path: /services/{version}/tasks/{task}

Common/Configuration

Service Configuration Summary: Method: get
Path: /services/{version}/config/summary
Service Health Details: Method: get
Path: /services/{version}/config/health
Service Health Summary: Method: get
Path: /services/{version}/config/health/check

Common/Content Requests

Static Files: Method: get
Path: /services/{version}/content
Static Files: Method: get
Path: /services/{version}/content/{a}
Static Files: Method: get
Path: /services/{version}/content/{a}/{b}
Static Files: Method: get
Path: /services/{version}/content/{a}/{b}/{c}
Static Files: Method: get
Path: /services/{version}/content/{a}/{b}/{c}/{d}
Static Files: Method: get
Path: /services/{version}/content/{a}/{b}/{c}/{d}/{e}
Static Files: Method: get
Path: /services/{version}/content/{a}/{b}/{c}/{d}/{e}/{f}
Static Files: Method: get
Path: /services/{version}/content/{a}/{b}/{c}/{d}/{e}/{f}/{g}
Static Files: Method: get
Path: /services/{version}/content/{a}/{b}/{c}/{d}/{e}/{f}/{g}/{h}
Static Files: Method: get
Path: /services/{version}/content/{a}/{b}/{c}/{d}/{e}/{f}/{g}/{h}/{i}
Static Files: Method: get
Path: /services/{version}/content/{a}/{b}/{c}/{d}/{e}/{f}/{g}/{h}/{i}/{j}

Common/Logs

Modify Log Properties: Method: patch
Path: /services/{version}/logs/{log}
Reset Log Data: Method: delete
Path: /services/{version}/logs/{log}
Retrieve Log: Method: get
Path: /services/{version}/logs/{log}

Common/Message Codes

Retrieve List of Message Codes: Method: get
Path: /services/{version}/oggerr
Retrieve Message Explanation: Method: get
Path: /services/{version}/oggerr/{message}

Common/REST API Catalog

Describe API Version: Method: get
Path: /services/{version}
Describe Catalog Item: Method: get
Path: /services/{version}/metadata-catalog/{resource}
Retrieve API Versions: Method: get
Path: /services
Retrieve Catalog: Method: get
Path: /services/{version}/metadata-catalog

Common/Requests

Retrieve Background Requests: Method: get
Path: /services/{version}/requests
Retrieve Request Result: Method: get
Path: /services/{version}/requests/{request}/result
Retrieve Request Status: Method: get
Path: /services/{version}/requests/{request}

Common/User Information

Reset Information: Method: delete
Path: /services/{version}/currentuser
Retrieve Information: Method: get
Path: /services/{version}/currentuser

Common/User Management

User management features are available for Service Manager and Administrative Server

Bulk Create Users for Role: Method: post
Path: /services/{version}/authorizations/{role}
Create User: Method: post
Path: /services/{version}/authorizations/{role}/{user}
Delete User: Method: delete
Path: /services/{version}/authorizations/{role}/{user}
List User Roles: Method: get
Path: /services/{version}/authorizations
List Users: Method: get
Path: /services/{version}/authorizations/{role}
Retrieve User: Method: get
Path: /services/{version}/authorizations/{role}/{user}
Update User: Method: patch
Path: /services/{version}/authorizations/{role}/{user}

Distribution Service

Oracle GoldenGate Distribution Service

Create a new Oracle GoldenGate Distribution Path: Method: post
Path: /services/{version}/sources/{distpath}
Delete an existing Oracle GoldenGate Distribution Path: Method: delete
Path: /services/{version}/sources/{distpath}
Get a list of distribution paths: Method: get
Path: /services/{version}/sources
Get a list of the deployment extracts with their trail files: Method: get
Path: /services/{version}/exttrails
Retrieve an existing Oracle GoldenGate Distribution Path: Method: get
Path: /services/{version}/sources/{distpath}
Retrieve an existing Oracle GoldenGate Distribution Path Checkpoints: Method: get
Path: /services/{version}/sources/{distpath}/checkpoints
Retrieve an existing Oracle GoldenGate Distribution Path Information: Method: get
Path: /services/{version}/sources/{distpath}/info
Retrieve an existing Oracle GoldenGate Distribution Path Statistics: Method: get
Path: /services/{version}/sources/{distpath}/stats
Update an existing distribution path. A user with the Operator role may change the status property. Any other changes require the Administrator role.: Method: patch
Path: /services/{version}/sources/{distpath}

Performance Metrics Server/Commands

The operations from the Performance Metrics Server/Commands category.

Execute a command: Method: post
Path: /services/{version}/monitoring/commands/execute
Retrieve the list of commands: Method: get
Path: /services/{version}/monitoring/commands

Performance Metrics Server/ER Metrics

The operations from the Performance Metrics Server/ER Metrics category.

Retrieve an existing Basic Configuration Information for Extract and Replicat: Method: get
Path: /services/{version}/mpoints/{item}/configurationEr
Retrieve an existing Basic Configuration Information for Manager and Services: Method: get
Path: /services/{version}/mpoints/{item}/configurationManager
Retrieve an existing Checkpoint Position Information: Method: get
Path: /services/{version}/mpoints/{item}/positionEr

Performance Metrics Server/Extract Metrics

The operations from the Performance Metrics Server/Extract Metrics category.

Retrieve an existing Extract Database Statistics: Method: get
Path: /services/{version}/mpoints/{item}/statisticsExtract
Retrieve an existing Extract Database Statistics by Procedure Feature: Method: get
Path: /services/{version}/mpoints/{item}/statisticsProcedureExtract
Retrieve an existing Extract Database Statistics by Table: Method: get
Path: /services/{version}/mpoints/{item}/statisticsTableExtract
Retrieve an existing In Flight Transaction Information: Method: get
Path: /services/{version}/mpoints/{item}/currentInflightTransactions

Performance Metrics Server/Last Message Number

The operations from the Performance Metrics Server/Last Message Number category.

Retrieve an existing Last message id number: Method: get
Path: /services/{version}/monitoring/lastMessageId

Performance Metrics Server/Last Status Change Id Number

The operations from the Performance Metrics Server/Last Status Change Id Number category.

Retrieve an existing Last status change id number: Method: get
Path: /services/{version}/monitoring/lastStatusChangeId

Performance Metrics Server/Messages

The operations from the Performance Metrics Server/Messages category.

Retrieve an existing Process Messages: Method: get
Path: /services/{version}/monitoring/messages
Retrieve an existing Process Messages: Method: get
Path: /services/{version}/monitoring/{item}/messages

Performance Metrics Server/Process Metrics

The operations from the Performance Metrics Server/Process Metrics category.

Retrieve an existing Cache Manager Statistics: Method: get
Path: /services/{version}/mpoints/{item}/cacheStatistics
Retrieve an existing Database Information: Method: get
Path: /services/{version}/mpoints/{item}/databaseInOut
Retrieve an existing Input Trail File Statistics: Method: get
Path: /services/{version}/mpoints/{item}/trailInput
Retrieve an existing Network Statistics: Method: get
Path: /services/{version}/mpoints/{item}/networkStatistics
Retrieve an existing Output Trail File Statistics: Method: get
Path: /services/{version}/mpoints/{item}/trailOutput
Retrieve an existing Process Information: Method: get
Path: /services/{version}/mpoints/processes
Retrieve an existing Process Information: Method: get
Path: /services/{version}/mpoints/{item}/process
Retrieve an existing Process Performance Resource Utilization Information: Method: get
Path: /services/{version}/mpoints/{item}/processPerformance
Retrieve an existing Process Thread Resource Utilization Information: Method: get
Path: /services/{version}/mpoints/{item}/threadPerformance
Retrieve an existing Queue Bucket Statistics: Method: get
Path: /services/{version}/mpoints/{item}/queueBucketStatistics
Retrieve an existing Queue Statistics: Method: get
Path: /services/{version}/mpoints/{item}/queueStatistics
Retrieve an existing Super Pool Statistics: Method: get
Path: /services/{version}/mpoints/{item}/superpoolStatistics

Performance Metrics Server/Replicat Metrics

The operations from the Performance Metrics Server/Replicat Metrics category.

Retrieve an existing Coordinated Replicat Statistics: Method: get
Path: /services/{version}/mpoints/{item}/coordinationReplicat
Retrieve an existing Database Statistics by Procedure Feature: Method: get
Path: /services/{version}/mpoints/{item}/statisticsProcedureReplicat
Retrieve an existing Integrated Replicat Batch SQL Statistics: Method: get
Path: /services/{version}/mpoints/{item}/batchSqlStatistics
Retrieve an existing Parallel Replicat Statistics: Method: get
Path: /services/{version}/mpoints/{item}/parallelReplicat
Retrieve an existing Replicat Database Statistics: Method: get
Path: /services/{version}/mpoints/{item}/statisticsReplicat
Retrieve an existing Replicat Database Statistics by Table: Method: get
Path: /services/{version}/mpoints/{item}/statisticsTableReplicat
Retrieve an existing Statistics about dependencies: Method: get
Path: /services/{version}/mpoints/{item}/dependencyStats

Performance Metrics Server/Service Metrics

The operations from the Performance Metrics Server/Service Metrics category.

Retrieve an existing Distribution Server Chunk Statistics: Method: get
Path: /services/{version}/mpoints/{item}/distsrvrChunkStats
Retrieve an existing Distribution Server Network Statistics: Method: get
Path: /services/{version}/mpoints/{item}/distsrvrNetworkStats
Retrieve an existing Distribution Server Path Statistics: Method: get
Path: /services/{version}/mpoints/{item}/distsrvrPathStats
Retrieve an existing Distribution Server Path Statistics: Method: get
Path: /services/{version}/mpoints/{item}/distsrvrTableStats
Retrieve an existing PM Service Collector Statistics: Method: get
Path: /services/{version}/mpoints/{item}/pmsrvrStats
Retrieve an existing PM Service Monitored Process Statistics: Method: get
Path: /services/{version}/mpoints/{item}/pmsrvrProcStats
Retrieve an existing PM Service Worker Thread Statistics: Method: get
Path: /services/{version}/mpoints/{item}/pmsrvrWorkerStats
Retrieve an existing Receiver Service Statistics: Method: get
Path: /services/{version}/mpoints/{item}/recvsrvrStats

Performance Metrics Server/Status Changes

The operations from the Performance Metrics Server/Status Changes category.

Retrieve an existing Process Status Changes: Method: get
Path: /services/{version}/monitoring/statusChanges
Retrieve an existing Process Status Changes: Method: get
Path: /services/{version}/monitoring/{item}/statusChanges

Receiver Service

Oracle GoldenGate Receiver Service

Create a new Oracle GoldenGate Collector Path: Method: post
Path: /services/{version}/targets/{path}
Delete an existing Oracle GoldenGate Collector Path: Method: delete
Path: /services/{version}/targets/{path}
Get a list of distribution paths: Method: get
Path: /services/{version}/targets
Retrieve an existing Oracle GoldenGate Collector Path: Method: get
Path: /services/{version}/targets/{path}
Retrieve an existing Oracle GoldenGate Receiver Server Path Checkpoints: Method: get
Path: /services/{version}/targets/{path}/checkpoints
Retrieve an existing Oracle GoldenGate Receiver Server Path Information: Method: get
Path: /services/{version}/targets/{path}/info
Retrieve an existing Oracle GoldenGate Receiver Server Path Stats: Method: get
Path: /services/{version}/targets/{path}/stats
Retrieve an existing Oracle Receiver Server Progress: Method: get
Path: /services/{version}/targets/{path}/progress
Update an existing Oracle GoldenGate Collector Path: Method: patch
Path: /services/{version}/targets/{path}

Service Manager/Deployments

Create a Deployment: Method: post
Path: /services/{version}/deployments/{deployment}
List Deployments: Method: get
Path: /services/{version}/deployments
Remove a Deployment: Method: delete
Path: /services/{version}/deployments/{deployment}
Retrieve Deployment: Method: get
Path: /services/{version}/deployments/{deployment}
Update a Deployment: Method: patch
Path: /services/{version}/deployments/{deployment}

Service Manager/Installation

The operations from the Service Manager/Installation category.

Retrieve Deployment List: Method: get
Path: /services/{version}/installation/deployments
Retrieve Service List: Method: get
Path: /services/{version}/installation/services

Service Manager/Services

Create a Service: Method: post
Path: /services/{version}/deployments/{deployment}/services/{service}
Default Log: Method: get
Path: /services/{version}/deployments/{deployment}/services/{service}/logs/default
List Service Logs: Method: get
Path: /services/{version}/deployments/{deployment}/services/{service}/logs
List Services: Method: get
Path: /services/{version}/deployments/{deployment}/services
Remove a Service: Method: delete
Path: /services/{version}/deployments/{deployment}/services/{service}
Retrieve Service: Method: get
Path: /services/{version}/deployments/{deployment}/services/{service}
Update Service Properties: Method: patch
Path: /services/{version}/deployments/{deployment}/services/{service}