All REST Endpoints
Administrative Server/Commands
WRITE ME
- Execute Command
- Method: postPath:
/services/{version}/commands/execute
Administrative Server/Configuration Settings
WRITE ME
- Create Configuration File
- Method: postPath:
/services/{version}/config/files/{file}
- Create Restart Rule
- Method: postPath:
/services/{version}/config/restart/{rule}
- Delete Configuration File
- Method: deletePath:
/services/{version}/config/files/{file}
- Delete Restart Rule
- Method: deletePath:
/services/{version}/config/restart/{rule}
- List Configuration Files
- Method: getPath:
/services/{version}/config/files
- List Restart Rules
- Method: getPath:
/services/{version}/config/restart
- Replace Configuration File
- Method: putPath:
/services/{version}/config/files/{file}
- Replace Restart Rule
- Method: putPath:
/services/{version}/config/restart/{rule}
- Retrieve Configuration File
- Method: getPath:
/services/{version}/config/files/{file}
- Retrieve Restart Rule
- Method: getPath:
/services/{version}/config/restart/{rule}
Administrative Server/Credentials
WRITE ME
- Create Alias
- Method: postPath:
/services/{version}/credentials/{domain}/{alias}
- Delete Alias
- Method: deletePath:
/services/{version}/credentials/{domain}/{alias}
- List Domain Aliases
- Method: getPath:
/services/{version}/credentials/{domain}
- List Domains
- Method: getPath:
/services/{version}/credentials
- Replace Alias
- Method: putPath:
/services/{version}/credentials/{domain}/{alias}
- Retrieve Alias
- Method: getPath:
/services/{version}/credentials/{domain}/{alias}
- Validate
- Method: getPath:
/services/{version}/credentials/{domain}/{alias}/valid
Administrative Server/Database
WRITE ME
- Create Connection
- Method: postPath:
/services/{version}/connections/{connection}
- Create Heartbeat Table
- Method: postPath:
/services/{version}/connections/{connection}/tables/heartbeat
- Delete Connection
- Method: deletePath:
/services/{version}/connections/{connection}
- Delete Heartbeat Table
- Method: deletePath:
/services/{version}/connections/{connection}/tables/heartbeat
- Delete Process Heartbeat Records
- Method: deletePath:
/services/{version}/connections/{connection}/tables/heartbeat/{process}
- List Connections
- Method: getPath:
/services/{version}/connections
- Manage Checkpoint Tables
- Method: postPath:
/services/{version}/connections/{connection}/tables/checkpoint
- Manage Procedural Supplemental Logging
- Method: postPath:
/services/{version}/connections/{connection}/trandata/procedure
- Manage Schema Supplemental Logging
- Method: postPath:
/services/{version}/connections/{connection}/trandata/schema
- Manage Table Supplemental Logging
- Method: postPath:
/services/{version}/connections/{connection}/trandata/table
- Manage Trace Tables
- Method: postPath:
/services/{version}/connections/{connection}/tables/trace
- Replace Connection
- Method: putPath:
/services/{version}/connections/{connection}
- Retrieve Connection
- Method: getPath:
/services/{version}/connections/{connection}
- Retrieve Heartbeat Table
- Method: getPath:
/services/{version}/connections/{connection}/tables/heartbeat
- Retrieve Process Heartbeat Records
- Method: getPath:
/services/{version}/connections/{connection}/tables/heartbeat/{process}
- Update Heartbeat Table
- Method: patchPath:
/services/{version}/connections/{connection}/tables/heartbeat
Administrative Server/Encryption Keys
The operations from the Administrative Server/Encryption Keys category.
- Create Encryption Key
- Method: postPath:
/services/{version}/enckeys/{keyName}
- Delete Encryption Key
- Method: deletePath:
/services/{version}/enckeys/{keyName}
- Encrypt Data
- Method: postPath:
/services/{version}/enckeys/{keyName}/encrypt
- List Encryption Keys
- Method: getPath:
/services/{version}/enckeys
- Retrieve Encryption Key
- Method: getPath:
/services/{version}/enckeys/{keyName}
Administrative Server/Extracts
WRITE ME
- Create Extract
- Method: postPath:
/services/{version}/extracts/{extract}
- Delete Extract
- Method: deletePath:
/services/{version}/extracts/{extract}
- Issue Command
- Method: postPath:
/services/{version}/extracts/{extract}/command
- List Extracts
- Method: getPath:
/services/{version}/extracts
- List Information Types
- Method: getPath:
/services/{version}/extracts/{extract}/info
- List Reports
- Method: getPath:
/services/{version}/extracts/{extract}/info/reports
- Retrieve Checkpoints
- Method: getPath:
/services/{version}/extracts/{extract}/info/checkpoints
- Retrieve Extract
- Method: getPath:
/services/{version}/extracts/{extract}
- Retrieve Report
- Method: getPath:
/services/{version}/extracts/{extract}/info/reports/{report}
- Retrieve Status
- Method: getPath:
/services/{version}/extracts/{extract}/info/status
- Update Extract
- Method: patchPath:
/services/{version}/extracts/{extract}
Administrative Server/Logs
WRITE ME
- Critical Events
- Method: getPath:
/services/{version}/logs/events
Administrative Server/Master Keys
WRITE ME
- Create Version
- Method: postPath:
/services/{version}/masterkey
- Delete Version
- Method: deletePath:
/services/{version}/masterkey/{keyVersion}
- List Versions
- Method: getPath:
/services/{version}/masterkey
- Retrieve Version
- Method: getPath:
/services/{version}/masterkey/{keyVersion}
- Update Version
- Method: patchPath:
/services/{version}/masterkey/{keyVersion}
Administrative Server/Messages
The operations from the Administrative Server/Messages category.
- Retrieve Messages
- Method: getPath:
/services/{version}/messages
Administrative Server/Replicats
WRITE ME
- Create Replicat
- Method: postPath:
/services/{version}/replicats/{replicat}
- Delete Replicat
- Method: deletePath:
/services/{version}/replicats/{replicat}
- Issue Command
- Method: postPath:
/services/{version}/replicats/{replicat}/command
- List Information Types
- Method: getPath:
/services/{version}/replicats/{replicat}/info
- List Replicats
- Method: getPath:
/services/{version}/replicats
- List Reports
- Method: getPath:
/services/{version}/replicats/{replicat}/info/reports
- Retrieve Checkpoints
- Method: getPath:
/services/{version}/replicats/{replicat}/info/checkpoints
- Retrieve Replicat
- Method: getPath:
/services/{version}/replicats/{replicat}
- Retrieve Report
- Method: getPath:
/services/{version}/replicats/{replicat}/info/reports/{report}
- Retrieve Status
- Method: getPath:
/services/{version}/replicats/{replicat}/info/status
- Update Replicat
- Method: patchPath:
/services/{version}/replicats/{replicat}
Administrative Server/Tasks
WRITE ME
- Create Task
- Method: postPath:
/services/{version}/tasks/{task}
- Delete Task
- Method: deletePath:
/services/{version}/tasks/{task}
- List Information Types
- Method: getPath:
/services/{version}/tasks/{task}/info
- List Tasks
- Method: getPath:
/services/{version}/tasks
- Retrieve Task
- Method: getPath:
/services/{version}/tasks/{task}
- Retrieve Task History
- Method: getPath:
/services/{version}/tasks/{task}/info/history
- Retrieve Task Status
- Method: getPath:
/services/{version}/tasks/{task}/info/status
- Update Task
- Method: patchPath:
/services/{version}/tasks/{task}
Administrative Server/User Management
WRITE ME
- Bulk Create Users for Role
- Method: postPath:
/services/{version}/authorizations/{role}
- Create User
- Method: postPath:
/services/{version}/authorizations/{role}/{user}
- Delete User
- Method: deletePath:
/services/{version}/authorizations/{role}/{user}
- List User Roles
- Method: getPath:
/services/{version}/authorizations
- List Users
- Method: getPath:
/services/{version}/authorizations/{role}
- Retrieve User
- Method: getPath:
/services/{version}/authorizations/{role}/{user}
- Update User
- Method: patchPath:
/services/{version}/authorizations/{role}/{user}
Common/Configuration
The operations from the Common/Configuration category.
- Service Configuration Summary
- Method: getPath:
/services/{version}/config/summary
- Service Health Summary
- Method: getPath:
/services/{version}/config/health
Common/Content Requests
The operations from the Common/Content Requests category.
- Static Files
- Method: getPath:
/services/{version}/content
- Static Files
- Method: getPath:
/services/{version}/content/{a}
- Static Files
- Method: getPath:
/services/{version}/content/{a}/{b}
- Static Files
- Method: getPath:
/services/{version}/content/{a}/{b}/{c}
- Static Files
- Method: getPath:
/services/{version}/content/{a}/{b}/{c}/{d}
- Static Files
- Method: getPath:
/services/{version}/content/{a}/{b}/{c}/{d}/{e}
- Static Files
- Method: getPath:
/services/{version}/content/{a}/{b}/{c}/{d}/{e}/{f}
- Static Files
- Method: getPath:
/services/{version}/content/{a}/{b}/{c}/{d}/{e}/{f}/{g}
- Static Files
- Method: getPath:
/services/{version}/content/{a}/{b}/{c}/{d}/{e}/{f}/{g}/{h}
- Static Files
- Method: getPath:
/services/{version}/content/{a}/{b}/{c}/{d}/{e}/{f}/{g}/{h}/{i}
- Static Files
- Method: getPath:
/services/{version}/content/{a}/{b}/{c}/{d}/{e}/{f}/{g}/{h}/{i}/{j}
Common/Logs
WRITE ME
- Modify Log Properties
- Method: patchPath:
/services/{version}/logs/{log}
- Reset Log Data
- Method: deletePath:
/services/{version}/logs/{log}
- Retrieve Available Logs
- Method: getPath:
/services/{version}/logs
- Retrieve Log
- Method: getPath:
/services/{version}/logs/{log}
Common/Message Codes
The operations from the Common/Message Codes category.
- Retrieve List of Message Codes
- Method: getPath:
/services/{version}/oggerr
- Retrieve Message Explanation
- Method: getPath:
/services/{version}/oggerr/{message}
Common/REST API Catalog
WRITE ME
- Describe API Version
- Method: getPath:
/services/{version}
- Describe Catalog Item
- Method: getPath:
/services/{version}/metadata-catalog/{resource}
- Retrieve API Versions
- Method: getPath:
/services
- Retrieve Catalog
- Method: getPath:
/services/{version}/metadata-catalog
Common/Requests
WRITE ME
- Retrieve Background Requests
- Method: getPath:
/services/{version}/requests
- Retrieve Request Result
- Method: getPath:
/services/{version}/requests/{request}/result
- Retrieve Request Status
- Method: getPath:
/services/{version}/requests/{request}
Common/User Information
The operations from the Common/User Information category.
- Reset Information
- Method: deletePath:
/services/{version}/currentuser
- Retrieve Information
- Method: getPath:
/services/{version}/currentuser
Distribution Server
Oracle GoldenGate Distribution Server
- Create a new Oracle GoldenGate Distribution Path
- Method: postPath:
/services/{version}/sources/{distpath}
- Delete an existing Oracle GoldenGate Distribution Path
- Method: deletePath:
/services/{version}/sources/{distpath}
- Get a list of distribution paths
- Method: getPath:
/services/{version}/sources
- Get a list of the deployment extracts with their trail files
- Method: getPath:
/services/{version}/exttrails
- Retrieve an existing Oracle GoldenGate Distribution Path
- Method: getPath:
/services/{version}/sources/{distpath}
- Retrieve an existing Oracle GoldenGate Distribution Path Checkpoints
- Method: getPath:
/services/{version}/sources/{distpath}/checkpoints
- Retrieve an existing Oracle GoldenGate Distribution Path Information
- Method: getPath:
/services/{version}/sources/{distpath}/info
- Retrieve an existing Oracle GoldenGate Distribution Path Statistics
- Method: getPath:
/services/{version}/sources/{distpath}/stats
- Update an existing Oracle GoldenGate Distribution Path
- Method: patchPath:
/services/{version}/sources/{distpath}
Performance Metrics Server/Commands
The operations from the Performance Metrics Server/Commands category.
- Execute a command
- Method: postPath:
/services/{version}/monitoring/commands/execute
- Retrieve the list of commands
- Method: getPath:
/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: getPath:
/services/{version}/mpoints/{item}/configurationEr
- Retrieve an existing Basic Configuration Information for Manager and Services
- Method: getPath:
/services/{version}/mpoints/{item}/configurationManager
- Retrieve an existing Checkpoint Position Information
- Method: getPath:
/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: getPath:
/services/{version}/mpoints/{item}/statisticsExtract
- Retrieve an existing Extract Database Statistics by Procedure Feature
- Method: getPath:
/services/{version}/mpoints/{item}/statisticsProcedureExtract
- Retrieve an existing Extract Database Statistics by Table
- Method: getPath:
/services/{version}/mpoints/{item}/statisticsTableExtract
- Retrieve an existing In Flight Transaction Information
- Method: getPath:
/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: getPath:
/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: getPath:
/services/{version}/monitoring/lastStatusChangeId
Performance Metrics Server/Messages
The operations from the Performance Metrics Server/Messages category.
- Retrieve an existing Process Messages
- Method: getPath:
/services/{version}/monitoring/messages
- Retrieve an existing Process Messages
- Method: getPath:
/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: getPath:
/services/{version}/mpoints/{item}/cacheStatistics
- Retrieve an existing Database Information
- Method: getPath:
/services/{version}/mpoints/{item}/databaseInOut
- Retrieve an existing Input Trail File Statistics
- Method: getPath:
/services/{version}/mpoints/{item}/trailInput
- Retrieve an existing Network Statistics
- Method: getPath:
/services/{version}/mpoints/{item}/networkStatistics
- Retrieve an existing Output Trail File Statistics
- Method: getPath:
/services/{version}/mpoints/{item}/trailOutput
- Retrieve an existing Process Information
- Method: getPath:
/services/{version}/mpoints/processes
- Retrieve an existing Process Information
- Method: getPath:
/services/{version}/mpoints/{item}/process
- Retrieve an existing Process Performance Resource Utilization Information
- Method: getPath:
/services/{version}/mpoints/{item}/processPerformance
- Retrieve an existing Process Thread Resource Utilization Information
- Method: getPath:
/services/{version}/mpoints/{item}/threadPerformance
- Retrieve an existing Queue Bucket Statistics
- Method: getPath:
/services/{version}/mpoints/{item}/queueBucketStatistics
- Retrieve an existing Queue Statistics
- Method: getPath:
/services/{version}/mpoints/{item}/queueStatistics
- Retrieve an existing Super Pool Statistics
- Method: getPath:
/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: getPath:
/services/{version}/mpoints/{item}/coordinationReplicat
- Retrieve an existing Database Statistics by Procedure Feature
- Method: getPath:
/services/{version}/mpoints/{item}/statisticsProcedureReplicat
- Retrieve an existing Integrated Replicat Batch SQL Statistics
- Method: getPath:
/services/{version}/mpoints/{item}/batchSqlStatistics
- Retrieve an existing Parallel Replicat Statistics
- Method: getPath:
/services/{version}/mpoints/{item}/parallelReplicat
- Retrieve an existing Replicat Database Statistics
- Method: getPath:
/services/{version}/mpoints/{item}/statisticsReplicat
- Retrieve an existing Replicat Database Statistics by Table
- Method: getPath:
/services/{version}/mpoints/{item}/statisticsTableReplicat
Performance Metrics Server/Service Metrics
The operations from the Performance Metrics Server/Service Metrics category.
- Retrieve an existing Distribution Server Chunk Statistics
- Method: getPath:
/services/{version}/mpoints/{item}/distsrvrChunkStats
- Retrieve an existing Distribution Server Network Statistics
- Method: getPath:
/services/{version}/mpoints/{item}/distsrvrNetworkStats
- Retrieve an existing Distribution Server Path Statistics
- Method: getPath:
/services/{version}/mpoints/{item}/distsrvrPathStats
- Retrieve an existing Distribution Server Path Statistics
- Method: getPath:
/services/{version}/mpoints/{item}/distsrvrTableStats
- Retrieve an existing PM Service Collector Statistics
- Method: getPath:
/services/{version}/mpoints/{item}/pmsrvrStats
- Retrieve an existing PM Service Monitored Process Statistics
- Method: getPath:
/services/{version}/mpoints/{item}/pmsrvrProcStats
- Retrieve an existing PM Service Worker Thread Statistics
- Method: getPath:
/services/{version}/mpoints/{item}/pmsrvrWorkerStats
- Retrieve an existing Receiver Service Statistics
- Method: getPath:
/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: getPath:
/services/{version}/monitoring/statusChanges
- Retrieve an existing Process Status Changes
- Method: getPath:
/services/{version}/monitoring/{item}/statusChanges
Receiver Server
Oracle GoldenGate Receiver Server
- Get a list of distribution paths
- Method: getPath:
/services/{version}/targets
- Retrieve an existing Oracle GoldenGate Collector Path
- Method: getPath:
/services/{version}/targets/{path}
- Retrieve an existing Oracle GoldenGate Distribution Collector Path Stats
- Method: getPath:
/services/{version}/targets/{path}/stats
- Retrieve an existing Oracle Receiver Server Progress
- Method: getPath:
/services/{version}/targets/{path}/progress
- Update an existing Oracle GoldenGate Collector Path
- Method: patchPath:
/services/{version}/targets/{path}
Service Manager/Deployments
WRITE ME
- Create a Deployment
- Method: postPath:
/services/{version}/deployments/{deployment}
- List Deployments
- Method: getPath:
/services/{version}/deployments
- Remove a Deployment
- Method: deletePath:
/services/{version}/deployments/{deployment}
- Retrieve Deployment
- Method: getPath:
/services/{version}/deployments/{deployment}
- Update a Deployment
- Method: patchPath:
/services/{version}/deployments/{deployment}
Service Manager/Services
WRITE ME
- Create a Service
- Method: postPath:
/services/{version}/deployments/{deployment}/services/{service}
- Default Log
- Method: getPath:
/services/{version}/deployments/{deployment}/services/{service}/logs/default
- List Service Logs
- Method: getPath:
/services/{version}/deployments/{deployment}/services/{service}/logs
- List Services
- Method: getPath:
/services/{version}/deployments/{deployment}/services
- Remove a Service
- Method: deletePath:
/services/{version}/deployments/{deployment}/services/{service}
- Retrieve Service
- Method: getPath:
/services/{version}/deployments/{deployment}/services/{service}
- Update Service Properties
- Method: patchPath:
/services/{version}/deployments/{deployment}/services/{service}