• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Send Requests
• Authentication
• Status Codes
• Error Messages
• cURL Access

Tasks

• Administration Service
  • Commands
    • Execute Command
  • Credentials
    • Create Alias
    • Delete Alias
    • List Domain Aliases
    • List Domains
    • Replace Alias
    • Retrieve Alias
    • Validate
  • Database
    • Create Connection
    • Create Heartbeat Table
    • Delete Connection
    • Delete Heartbeat Table
    • Delete Process Heartbeat Records
    • List Connections
    • Manage Checkpoint Tables
    • Manage Instantiation CSN
    • Manage Procedural Supplemental Logging
    • Manage Schema Supplemental Logging
    • Manage Table Supplemental Logging
    • Replace Connection
    • Retrieve Active Transaction Details
    • Retrieve Connection
    • Retrieve Database Names
    • Retrieve Database Schemas
    • Retrieve Database Table Details
    • Retrieve Database Tables
    • Retrieve Heartbeat Table
    • Retrieve Heartbeat Table Entries
    • Retrieve Process Heartbeat Records
    • Update Heartbeat Table
  • Encryption Keys
    • Create Encryption Key
    • Delete Encryption Key
    • Encrypt Data
    • List Encryption Keys
    • Retrieve Encryption Key
  • Encryption Profiles
    • Create Encryption Profile
    • Delete Encryption Profile
    • List Encryption Profiles
    • Replace Encryption Profile
    • Retrieve Encryption Profile
    • Validate Encryption Profile
  • Extracts
    • Create Extract
    • Delete Extract
    • Issue Command
    • List Diagnostics
    • List Extracts
    • List Information Types
    • List Logs
    • List Reports
    • Retrieve Checkpoints
    • Retrieve Diagnostics
    • Retrieve Extract
    • Retrieve History
    • Retrieve Log
    • Retrieve Report
    • Retrieve Status
    • Update Extract
  • Logs
    • Critical Events
  • Master Keys
    • Create Version
    • Delete Version
    • List Versions
    • Retrieve Version
    • Update Version
  • Messages
    • Retrieve Messages
  • Parameters
    • List Parameter Names
    • Retrieve Parameter Info
  • Replicats
    • Create Replicat
    • Delete Replicat
    • Issue Command
    • List Diagnostics
    • List Information Types
    • List Logs
    • List Replicats
    • List Reports
    • Retrieve Checkpoints
    • Retrieve Diagnostics
    • Retrieve History
    • Retrieve Log
    • Retrieve Replicat
    • Retrieve Report
    • Retrieve Status
    • Update Replicat
  • Tasks
    • Create Task
    • Delete Task
    • List Information Types
    • List Tasks
    • Retrieve Task
    • Retrieve Task History
    • Retrieve Task Status
    • Update Task
  • Trails
    • Create Trail
    • Create Trail Sequence
    • Delete Trail
    • Delete Trail Sequence
    • Delete Trail Sequence Collection
    • List Trail Sequences
    • List Trails
    • Retrieve Trail
    • Retrieve Trail Sequence
    • Update Trail
• Common
  • Certificates
    • Retrieve Available Certificate Types
    • Retrieve Certificate
    • Retrieve Certificate Names
  • Configuration
    • Service Configuration Summary
    • Service Health Details
    • Service Health Summary
  • Configuration Settings
    • Create Configuration Data Type
    • Create Configuration File
    • Create Configuration Value
    • Delete Configuration Data Type
    • Delete Configuration File
    • Delete Configuration Value
    • List Configuration Data Types
    • List Configuration Files
    • List Configuration Values
    • Replace Configuration File
    • Replace Configuration Value
    • Retrieve Configuration Data Type
    • Retrieve Configuration File
    • Retrieve Configuration Value
  • Content Requests
    • Static Files
  • Installation
    • Retrieve Deployment List
    • Retrieve Service List
  • Logs
    • Modify Log Properties
    • Reset Log Data
    • Retrieve Available Logs
    • Retrieve Log
  • Message Codes
    • Retrieve List of Message Codes
    • Retrieve Message Explanation
  • Requests
    • Retrieve Background Requests
    • Retrieve Request Result
    • Retrieve Request Status
  • REST API Catalog
    • Describe API Version
    • Describe Catalog Item
    • Retrieve API Versions
    • Retrieve Catalog
  • User Information
    • Reset Information
    • Retrieve Information
  • User Management
    • Bulk Create Users for Role
    • Create User
    • Delete User
    • List User Roles
    • List Users
    • Retrieve Additional User Information
    • Retrieve User
    • Update User
• Data Stream Service error messages
  • Retrieve the data stream service error messages if applicable
• Distribution Service
  • Create a new Oracle GoldenGate Data Stream configuration
  • Create a new Oracle GoldenGate Distribution Path
  • Delete an existing Oracle GoldenGate Data Stream configuration
  • Delete an existing Oracle GoldenGate Distribution Path
  • Get a list of data stream resources
  • Get a list of distribution paths
  • Get a list of the deployment extracts with their trail files
  • Retrieve an existing Oracle GoldenGate Data Stream configuration
  • Retrieve an existing Oracle GoldenGate Data Stream Information
  • Retrieve an existing Oracle GoldenGate Distribution Path
  • Retrieve an existing Oracle GoldenGate Distribution Path Checkpoints
  • Retrieve an existing Oracle GoldenGate Distribution Path Information
  • Retrieve an existing Oracle GoldenGate Distribution Path Statistics
  • Retrieve the asyncapi yaml specification
  • Update an Existing Distribution Path
  • Update an existing Oracle GoldenGate Data Stream configuration
  • Update the AsyncAPI YAML Specification
  • Data Target
    • Json Schema
    • Types
• OAuth redirect URL
  • Receives the authorization code and exchanges it for an access and id token
• Performance Metrics Service
  • Commands
    • Execute a command
    • Retrieve the list of commands
  • Datastore
    • Retrieve
    • Update
  • ER Metrics
    • Retrieve an existing Basic Configuration Information for Extract and Replicat
    • Retrieve an existing Basic Configuration Information for Manager and Services
    • Retrieve an existing Checkpoint Position Information
  • Extract Metrics
    • Retrieve an existing Bounded Recovery Extant Object Ages Statistics
    • Retrieve an existing Bounded Recovery Extant Object Sizes Statistics
    • Retrieve an existing Bounded Recovery Object Ages Statistics
    • Retrieve an existing Bounded Recovery Object Pool Information
    • Retrieve an existing Bounded Recovery Object Sizes Statistics
    • Retrieve an existing Bounded Recovery Status
    • Retrieve an existing Extract Database Statistics
    • Retrieve an existing Extract Database Statistics by Procedure Feature
    • Retrieve an existing Extract Database Statistics by Table
    • Retrieve an existing In Flight Transaction Information
  • Heartbeat Metrics
    • Retrieve an existing Heartbeat timings
  • Last Message Number
    • Retrieve an existing Last message id number
  • Last Status Change Id Number
    • Retrieve an existing Last status change id number
  • Messages
    • Retrieve an existing Process Messages
    • Retrieve an existing Process Messages
  • Process Metrics
    • Retrieve an existing Cache Manager Statistics
    • Retrieve an existing Database Information
    • Retrieve an existing Input Trail File Statistics
    • Retrieve an existing Network Statistics
    • Retrieve an existing Output Trail File Statistics
    • Retrieve an existing Process Information
    • Retrieve an existing Process Information
    • Retrieve an existing Process Performance Resource Utilization Information
    • Retrieve an existing Process Thread Resource Utilization Information
    • Retrieve an existing Queue Bucket Statistics
    • Retrieve an existing Queue Statistics
    • Retrieve an existing Super Pool Statistics
  • Replicat Metrics
    • Retrieve an existing Coordinated Replicat Statistics
    • Retrieve an existing Database Statistics by Procedure Feature
    • Retrieve an existing Integrated Replicat Batch SQL Statistics
    • Retrieve an existing Parallel Replicat Statistics
    • Retrieve an existing Replicat Database Statistics
    • Retrieve an existing Replicat Database Statistics by Table
    • Retrieve an existing Statistics about dependencies
  • Service Metrics
    • Retrieve an existing Distribution Service Chunk Statistics
    • Retrieve an existing Distribution Service Network Statistics
    • Retrieve an existing Distribution Service Path Statistics
    • Retrieve an existing Distribution Service Table Statistics
    • Retrieve an existing Performance Metrics Service Collector Statistics
    • Retrieve an existing Performance Metrics Service Monitored Process Statistics
    • Retrieve an existing Performance Metrics Service Worker Thread Statistics
    • Retrieve an existing Receiver Service Statistics
    • Retrieve an existing Service Health
  • Status Changes
    • Retrieve an existing Process Status Changes
    • Retrieve an existing Process Status Changes
• Reauthorize current user
  • Use this endpoint to reauthorize the current user
• Receiver Service
  • Create a new Oracle GoldenGate Collector Path
  • Delete an existing Oracle GoldenGate Collector Path
  • Get a list of distribution paths
  • Retrieve an existing Oracle GoldenGate Collector Path
  • Retrieve an existing Oracle GoldenGate Receiver Service Path Checkpoints
  • Retrieve an existing Oracle GoldenGate Receiver Service Path Information
  • Retrieve an existing Oracle GoldenGate Receiver Service Path Stats
  • Retrieve an existing Oracle GoldenGate Receiver Service Progress
  • Update an existing Oracle GoldenGate Collector Path
• Service Manager
  • Authorization Profiles
    • Create Authorization Profile
    • Delete Authorization Profile
    • Get Authorization Profile
    • Get Authorization Profiles
    • Patch Authorization Profile
    • Test Authorization Profile
  • Certificates
    • Add a Named Certificate
    • Delete a Named Certificate
    • Replace a Named Certificate
    • Retrieve Available Certificate Types
    • Retrieve Certificate
    • Retrieve Certificate Information
    • Retrieve Certificate Information
    • Retrieve Certificate Types
  • Cluster Management
    • Add Installation to Cluster
    • Add Remote Installation to Cluster
    • Delete Cluster Member
    • Get Cluster Details
    • Remove Installation from Cluster
    • Retrieve Cluster Role
    • Update Cluster Role
  • Deployments
    • Create a Deployment
    • List Deployments
    • Remove a Deployment
    • Retrieve Deployment
    • Update a Deployment
  • Installation
    • Create Backend
    • Delete Backend
    • Get Backend
    • Get Backend List
    • Get Configuration
    • Replace Backend
    • Update Backend
    • Update Configuration
  • Plugin Management
    • Get Plugin Details
    • List Plugins
  • Plugin Templates
    • Create Plugin Template
    • Delete Plugin Template
    • Get Plugin Template
    • Get Plugin Templates
    • Update Plugin Template
  • Services
    • Create a Service
    • Default Log
    • List Service Logs
    • List Services
    • Remove a Service
    • Retrieve Service
    • Update Service Properties