Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

All REST Endpoints

Administration Service/Commands

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

Administration Service/Credentials

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

Administration Service/Database

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
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 Heartbeat Table Entries: Method: get
Path: /services/{version}/connections/{connection}/tables/heartbeatData
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

Administration Service/Encryption Keys

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}

Administration Service/Encryption Profiles

Create Encryption Profile: Method: post
Path: /services/{version}/encryption/profiles/{profile}
Delete Encryption Profile: Method: delete
Path: /services/{version}/encryption/profiles/{profile}
List Encryption Profiles: Method: get
Path: /services/{version}/encryption/profiles
Replace Encryption Profile: Method: patch
Path: /services/{version}/encryption/profiles/{profile}
Retrieve Encryption Profile: Method: get
Path: /services/{version}/encryption/profiles/{profile}
Validate Encryption Profile: Method: get
Path: /services/{version}/encryption/profiles/{profile}/valid

Administration Service/Extracts

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 Diagnostics: Method: get
Path: /services/{version}/extracts/{extract}/info/diagnostics
List Extracts: Method: get
Path: /services/{version}/extracts
List Information Types: Method: get
Path: /services/{version}/extracts/{extract}/info
List Logs: Method: get
Path: /services/{version}/extracts/{extract}/info/logs
List Reports: Method: get
Path: /services/{version}/extracts/{extract}/info/reports
Retrieve Checkpoints: Method: get
Path: /services/{version}/extracts/{extract}/info/checkpoints
Retrieve Diagnostics: Method: get
Path: /services/{version}/extracts/{extract}/info/diagnostics/{diagnostic}
Retrieve Extract: Method: get
Path: /services/{version}/extracts/{extract}
Retrieve History: Method: get
Path: /services/{version}/extracts/{extract}/info/history
Retrieve Log: Method: get
Path: /services/{version}/extracts/{extract}/info/logs/{log}
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}

Administration Service/Logs

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

Administration Service/Master Keys

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}

Administration Service/Messages

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

Administration Service/Parameters

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

Administration Service/Replicats

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 Diagnostics: Method: get
Path: /services/{version}/replicats/{replicat}/info/diagnostics
List Information Types: Method: get
Path: /services/{version}/replicats/{replicat}/info
List Logs: Method: get
Path: /services/{version}/replicats/{replicat}/info/logs
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 Diagnostics: Method: get
Path: /services/{version}/replicats/{replicat}/info/diagnostics/{diagnostic}
Retrieve History: Method: get
Path: /services/{version}/replicats/{replicat}/info/history
Retrieve Log: Method: get
Path: /services/{version}/replicats/{replicat}/info/logs/{log}
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}

Administration Service/Tasks

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}

Administration Service/Trails

The operations from the Administration Service/Trails category.

Create Trail: Method: post
Path: /services/{version}/trails/{trail}
Create Trail Sequence: Method: post
Path: /services/{version}/trails/{trail}/sequences/{sequence}
Delete Trail: Method: delete
Path: /services/{version}/trails/{trail}
Delete Trail Sequence: Method: delete
Path: /services/{version}/trails/{trail}/sequences/{sequence}
Delete Trail Sequence Collection: Method: delete
Path: /services/{version}/trails/{trail}/sequences
List Trail Sequences: Method: get
Path: /services/{version}/trails/{trail}/sequences
List Trails: Method: get
Path: /services/{version}/trails
Retrieve Trail: Method: get
Path: /services/{version}/trails/{trail}
Retrieve Trail Sequence: Method: get
Path: /services/{version}/trails/{trail}/sequences/{sequence}
Update Trail: Method: patch
Path: /services/{version}/trails/{trail}

Common/Certificates

Retrieve Available Certificate Types: Method: get
Path: /services/{version}/certificates
Retrieve Certificate: Method: get
Path: /services/{version}/certificates/{type}/{certificate}
Retrieve Certificate Names: Method: get
Path: /services/{version}/certificates/{type}

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/Configuration Settings

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}

Common/Content Requests

Static Files: Method: get
Path: /services/{version}/content

Common/Installation

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

Common/Logs

Modify Log Properties: Method: patch
Path: /services/{version}/logs/{log}
Reset Log Data: Method: delete
Path: /services/{version}/logs/{log}
Retrieve Available Logs: Method: get
Path: /services/{version}/logs
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 Additional User Information: Method: get
Path: /services/{version}/authorizations/{role}/{user}/info
Retrieve User: Method: get
Path: /services/{version}/authorizations/{role}/{user}
Update User: Method: patch
Path: /services/{version}/authorizations/{role}/{user}

Data Stream Service error messages

The operations from the Data Stream Service error messages category.

Retrieve the data stream service error messages if applicable: Method: get
Path: /services/{version}/stream/{streamName}/info/errors

Distribution Service

Oracle GoldenGate Distribution Service

Create a new Oracle GoldenGate Data Stream configuration: Method: post
Path: /services/{version}/stream/{streamName}
Create a new Oracle GoldenGate Distribution Path: Method: post
Path: /services/{version}/sources/{distpath}
Delete an existing Oracle GoldenGate Data Stream configuration: Method: delete
Path: /services/{version}/stream/{streamName}
Delete an existing Oracle GoldenGate Distribution Path: Method: delete
Path: /services/{version}/sources/{distpath}
Get a list of data stream resources: Method: get
Path: /services/{version}/stream
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 Data Stream configuration: Method: get
Path: /services/{version}/stream/{streamName}
Retrieve an existing Oracle GoldenGate Data Stream Information: Method: get
Path: /services/{version}/stream/{streamName}/info
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
Retrieve the asyncapi yaml specification: Method: get
Path: /services/{version}/stream/{streamName}/yaml
Update an Existing Distribution Path: Method: patch
Path: /services/{version}/sources/{distpath}
Update an existing Oracle GoldenGate Data Stream configuration: Method: patch
Path: /services/{version}/stream/{streamName}
Update the AsyncAPI YAML Specification: Method: patch
Path: /services/{version}/stream/{streamName}/yaml

Distribution Service/Data Target

The operations from the Distribution Service/Data Target category.

Json Schema: Method: get
Path: /services/{version}/dataTargetTypes/{dataTargetType}
Types: Method: get
Path: /services/{version}/dataTargetTypes

OAuth redirect URL

The operations from the OAuth redirect URL category.

Receives the authorization code and exchanges it for an access and id token: Method: get
Path: /services/{version}/authorization

Performance Metrics Service/Commands

The operations from the Performance Metrics Service/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 Service/Datastore

The operations from the Performance Metrics Service/Datastore category.

Retrieve: Method: get
Path: /services/{version}/datastore
Update: Method: patch
Path: /services/{version}/datastore

Performance Metrics Service/ER Metrics

The operations from the Performance Metrics Service/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 Service/Extract Metrics

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

Retrieve an existing Bounded Recovery Extant Object Ages Statistics: Method: get
Path: /services/{version}/mpoints/{item}/brExtantObjectAges
Retrieve an existing Bounded Recovery Extant Object Sizes Statistics: Method: get
Path: /services/{version}/mpoints/{item}/brExtantObjectSizes
Retrieve an existing Bounded Recovery Object Ages Statistics: Method: get
Path: /services/{version}/mpoints/{item}/brObjectAges
Retrieve an existing Bounded Recovery Object Pool Information: Method: get
Path: /services/{version}/mpoints/{item}/brPoolsInfo
Retrieve an existing Bounded Recovery Object Sizes Statistics: Method: get
Path: /services/{version}/mpoints/{item}/brObjectSizes
Retrieve an existing Bounded Recovery Status: Method: get
Path: /services/{version}/mpoints/{item}/brStatus
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 Service/Heartbeat Metrics

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

Retrieve an existing Heartbeat timings: Method: get
Path: /services/{version}/mpoints/{item}/heartbeat

Performance Metrics Service/Last Message Number

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

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

Performance Metrics Service/Last Status Change Id Number

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

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

Performance Metrics Service/Messages

The operations from the Performance Metrics Service/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 Service/Process Metrics

The operations from the Performance Metrics Service/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 Service/Replicat Metrics

The operations from the Performance Metrics Service/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 Service/Service Metrics

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

Retrieve an existing Distribution Service Chunk Statistics: Method: get
Path: /services/{version}/mpoints/{item}/distsrvrChunkStats
Retrieve an existing Distribution Service Network Statistics: Method: get
Path: /services/{version}/mpoints/{item}/distsrvrNetworkStats
Retrieve an existing Distribution Service Path Statistics: Method: get
Path: /services/{version}/mpoints/{item}/distsrvrPathStats
Retrieve an existing Distribution Service Table Statistics: Method: get
Path: /services/{version}/mpoints/{item}/distsrvrTableStats
Retrieve an existing Performance Metrics Service Collector Statistics: Method: get
Path: /services/{version}/mpoints/{item}/pmsrvrStats
Retrieve an existing Performance Metrics Service Monitored Process Statistics: Method: get
Path: /services/{version}/mpoints/{item}/pmsrvrProcStats
Retrieve an existing Performance Metrics 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
Retrieve an existing Service Health: Method: get
Path: /services/{version}/mpoints/{item}/serviceHealth

Performance Metrics Service/Status Changes

The operations from the Performance Metrics Service/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

Reauthorize current user

The operations from the Reauthorize current user category.

Use this endpoint to reauthorize the current user: Method: post
Path: /services/{version}/currentuser/reauthorize

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 Service Path Checkpoints: Method: get
Path: /services/{version}/targets/{path}/checkpoints
Retrieve an existing Oracle GoldenGate Receiver Service Path Information: Method: get
Path: /services/{version}/targets/{path}/info
Retrieve an existing Oracle GoldenGate Receiver Service Path Stats: Method: get
Path: /services/{version}/targets/{path}/stats
Retrieve an existing Oracle GoldenGate Receiver Service 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/Authorization Profiles

Create Authorization Profile: Method: post
Path: /services/{version}/deployments/{deployment}/authorization/profiles/{profile}
Delete Authorization Profile: Method: delete
Path: /services/{version}/deployments/{deployment}/authorization/profiles/{profile}
Get Authorization Profile: Method: get
Path: /services/{version}/deployments/{deployment}/authorization/profiles/{profile}
Get Authorization Profiles: Method: get
Path: /services/{version}/deployments/{deployment}/authorization/profiles
Patch Authorization Profile: Method: patch
Path: /services/{version}/deployments/{deployment}/authorization/profiles/{profile}
Test Authorization Profile: Method: get
Path: /services/{version}/deployments/{deployment}/authorization/profiles/{profile}/valid

Service Manager/Certificates

Add a Named Certificate: Method: post
Path: /services/{version}/deployments/{deployment}/certificates/{type}/{certificate}
Delete a Named Certificate: Method: delete
Path: /services/{version}/deployments/{deployment}/certificates/{type}/{certificate}
Replace a Named Certificate: Method: put
Path: /services/{version}/deployments/{deployment}/certificates/{type}/{certificate}
Retrieve Available Certificate Types: Method: get
Path: /services/{version}/deployments/{deployment}/certificates
Retrieve Certificate: Method: get
Path: /services/{version}/deployments/{deployment}/certificates/{type}/{certificate}
Retrieve Certificate Information: Method: get
Path: /services/{version}/certificates/{type}/{certificate}/info
Retrieve Certificate Information: Method: get
Path: /services/{version}/deployments/{deployment}/certificates/{type}/{certificate}/info
Retrieve Certificate Types: Method: get
Path: /services/{version}/deployments/{deployment}/certificates/{type}

Service Manager/Cluster Management

The operations from the Service Manager/Cluster Management category.

Add Installation to Cluster: Method: post
Path: /services/{version}/installation/cluster
Add Remote Installation to Cluster: Method: post
Path: /services/{version}/installation/cluster/actions/memberAdd
Delete Cluster Member: Method: delete
Path: /services/{version}/installation/cluster/role/{member}
Get Cluster Details: Method: get
Path: /services/{version}/installation/cluster
Remove Installation from Cluster: Method: delete
Path: /services/{version}/installation/cluster
Retrieve Cluster Role: Method: get
Path: /services/{version}/installation/cluster/role/{member}
Update Cluster Role: Method: patch
Path: /services/{version}/installation/cluster/role/{member}

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.

Create Backend: Method: post
Path: /services/{version}/installation/configuration/backends
Delete Backend: Method: delete
Path: /services/{version}/installation/configuration/backends/{backend}
Get Backend: Method: get
Path: /services/{version}/installation/configuration/backends/{backend}
Get Backend List: Method: get
Path: /services/{version}/installation/configuration/backends
Get Configuration: Method: get
Path: /services/{version}/installation/configuration
Replace Backend: Method: post
Path: /services/{version}/installation/configuration/backends/{backend}/actions/replaces
Update Backend: Method: patch
Path: /services/{version}/installation/configuration/backends/{backend}
Update Configuration: Method: patch
Path: /services/{version}/installation/configuration

Service Manager/Plugin Management

The operations from the Service Manager/Plugin Management category.

Get Plugin Details: Method: get
Path: /services/{version}/installation/plugins/{plugin}
List Plugins: Method: get
Path: /services/{version}/installation/plugins

Service Manager/Plugin Templates

The operations from the Service Manager/Plugin Templates category.

Create Plugin Template: Method: post
Path: /services/{version}/deployments/{deployment}/plugin/templates/{plugin}
Delete Plugin Template: Method: delete
Path: /services/{version}/deployments/{deployment}/plugin/templates/{plugin}
Get Plugin Template: Method: get
Path: /services/{version}/deployments/{deployment}/plugin/templates/{plugin}
Get Plugin Templates: Method: get
Path: /services/{version}/deployments/{deployment}/plugin/templates
Update Plugin Template: Method: put
Path: /services/{version}/deployments/{deployment}/plugin/templates/{plugin}

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}