REST API for Managing Oracle Coherence

All REST Endpoints

Cache

The Cache resource provides a set of endpoints for managing Coherence caches based on the cache service instance to which it belongs. Use this resource to access operational information and performance statistics. Cache data is aggregated across all cluster members or it can be viewed for each cluster member. Applications should initially use this resource to discover caches and their associated cache names. Cache names are required to access management data.

Reset Cache Statistics by Service: Method: post
Path: /management/coherence/cluster/services/{serviceName}/caches/{cacheName}/members/{memberIdentifier}/resetStatistics
Update a Cache Member: Method: post
Path: /management/coherence/cluster/services/{serviceName}/caches/{cacheName}/members/{memberIdentifier}
View Cache Information by Service: Method: get
Path: /management/coherence/cluster/services/{serviceName}/caches/{cacheName}
View Cache Member Information by Service: Method: get
Path: /management/coherence/cluster/services/{serviceName}/caches/{cacheName}/members/{memberIdentifier}
View Cache Members by Service: Method: get
Path: /management/coherence/cluster/services/{serviceName}/caches/{cacheName}/members
View Caches by Service: Method: get
Path: /management/coherence/cluster/services/{serviceName}/caches

Cache (Short Form)

The Cache (Short Form) resource provides a set of endpoints for managing Coherence caches and does not require the service name to which the cache belongs. Use this resource to access operational information and performance statistics. Cache data is aggregated across all cluster members or it can be viewed for each cluster member. Applications should initially use this resource to discover caches and their associated cache names. Cache names are required to access management data.

Reset Cache Statistics: Method: post
Path: /management/coherence/cluster/caches/{cacheName}/members/{memberIdentifier}/resetStatistics
Update Cache Member: Method: post
Path: /management/coherence/cluster/caches/{cacheName}/members/{memberIdentifier}
View Cache Information: Method: get
Path: /management/coherence/cluster/caches/{cacheName}
View Cache Member Information: Method: get
Path: /management/coherence/cluster/caches/{cacheName}/members/{memberIdentifier}
View Cache Members: Method: get
Path: /management/coherence/cluster/caches/{cacheName}/members
View Caches: Method: get
Path: /management/coherence/cluster/caches

Cluster

The Cluster resource provides a set of endpoints for managing a Coherence cluster and cluster members. Use this resource to access operational information, performance statistics and logs and to shutdown cluster members. Applications should initially use this resource to discover the cluster members and their associated member IDs. Member IDs are required to access management resources and endpoints that are specific to a cluster member.

Log Member State: Method: post
Path: /management/coherence/cluster/members/{memberIdentifier}/logMemberState
Log the Cluster State: Method: post
Path: /management/coherence/cluster/logClusterState
Perform a Cluster wide Java Flight Recorder (JFR) operation: Method: post
Path: /management/coherence/cluster/diagnostic-cmd/{jfrCmd}
Perform a Heap Dump: Method: post
Path: /management/coherence/cluster/dumpClusterHeap
Perform a Heap Dump for a Cluster Member: Method: post
Path: /management/coherence/cluster/members/{memberIdentifier}/dumpHeap
Perform a JFR operation for a Cluster Member: Method: post
Path: /management/coherence/cluster/members/{memberIdentifier}/diagnostic-cmd/{jfrCmd}
Reset Member Statistics: Method: post
Path: /management/coherence/cluster/members/{memberIdentifier}/resetStatistics
Shutdown a Cluster Member: Method: post
Path: /management/coherence/cluster/members/{memberIdentifier}/shutdown
Shutdown the Cluster: Method: post
Path: /management/coherence/cluster/shutdown
Track the Weakest Cluster Member: Method: post
Path: /management/coherence/cluster/members/{memberIdentifier}/networkStats/trackWeakestMember
Update a Member: Method: post
Path: /management/coherence/cluster/members/{memberIdentifier}
View Cluster Information: Method: get
Path: /management/coherence/cluster
View Cluster Members: Method: get
Path: /management/coherence/cluster/members
View Member Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}
View Network Statistics Between Members: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/networkStats
View Reporter Information of a Member: Method: get
Path: /management/coherence/cluster/reporters/{memberIdentifier}
View Reporter Members: Method: get
Path: /management/coherence/cluster/reporters

Coherence*Web

The Coherence*Web resource provides a set of endpoints for managing caches that are used for storing HTTP session data. Use this resource to access operational information and performance statistics. Management data is aggregated across all cluster members or it can be viewed for each cluster member. Applications should initially use this resource to discover web application IDs. Application IDs are required to access management data. This API is available only when you use the Coherence Enterprise Edition.

Clear Stored Coherence*Web Application Member Configuration: Method: post
Path: /management/coherence/cluster/webApplications/{appId}/members/{memberIdentifier}/clearStoredConfiguration
View Coherence*Web Application Information: Method: get
Path: /management/coherence/cluster/webApplications/{appId}
View Coherence*Web Application Member Information: Method: get
Path: /management/coherence/cluster/webApplications/{appId}/members/{memberIdentifier}
View Coherence*Web Application Members: Method: get
Path: /management/coherence/cluster/webApplications/{appId}/members
View Coherence*Web Applications: Method: get
Path: /management/coherence/cluster/webApplications

Federation

The Federation resource provides a set of endpoints for managing federation for a service. Use this resource to access operational information and performance statistics and to perform federation operations. This API is available only when you use the Coherence Grid Edition.

Pause Federation: Method: post
Path: /management/coherence/cluster/services/{serviceName}/federation/pause
Pause Federation to a Participant: Method: post
Path: /management/coherence/cluster/services/{serviceName}/federation/participants/{participantName}/pause
Replicate All Caches to a Participant: Method: post
Path: /management/coherence/cluster/services/{serviceName}/federation/participants/{participantName}/replicateAll
Reset Incoming Statistics of a Participant: Method: post
Path: /management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/federation/statistics/incoming/participants/{participantName}/resetstatistics
Reset Outgoing Statistics of a Participant: Method: post
Path: /management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/federation/statistics/outgoing/participants/{participantName}/resetstatistics
Start Federation: Method: post
Path: /management/coherence/cluster/services/{serviceName}/federation/start
Start Federation After Synchronizing: Method: post
Path: /management/coherence/cluster/services/{serviceName}/federation/startWithSync
Start Federation to a Participant: Method: post
Path: /management/coherence/cluster/services/{serviceName}/federation/participants/{participantName}/start
Start Federation to a Participant After Synchronizing: Method: post
Path: /management/coherence/cluster/services/{serviceName}/federation/participants/{participantName}/startWithSync
Start Federation With No Backlog: Method: post
Path: /management/coherence/cluster/services/{serviceName}/federation/startWithNoBacklog
Start Federation With no Backlog to a Participant: Method: post
Path: /management/coherence/cluster/services/{serviceName}/federation/participants/{participantName}/startWithNoBacklog
Stop Federation: Method: post
Path: /management/coherence/cluster/services/{serviceName}/federation/stop
Stop Federation to a Participant: Method: post
Path: /management/coherence/cluster/services/{serviceName}/federation/participants/{participantName}/stop
View Federation Coordinator Information: Method: get
Path: /management/coherence/cluster/services/{serviceName}/federation
View Federation State: Method: get
Path: /management/coherence/cluster/services/{serviceName}/federation/state
View Incoming Statistics: Method: get
Path: /management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/federation/statistics/incoming/participants
View Incoming Statistics of a Participant: Method: get
Path: /management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/federation/statistics/incoming/participants/{participantName}
View Outgoing Statistics: Method: get
Path: /management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/federation/statistics/outgoing/participants
View Outgoing Statistics of a Participant: Method: get
Path: /management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/federation/statistics/outgoing/participants/{participantName}
View Pending Incoming Message Count: Method: get
Path: /management/coherence/cluster/services/{serviceName}/federation/pendingIncomingMessages
View Pending Outgoing Message Count: Method: get
Path: /management/coherence/cluster/services/{serviceName}/federation/pendingOutgoingMessages

HotCache

The HotCache resource provides a set of endpoints for managing caches that are integrated with Oracle GoldenGate. Use this resource to access operational information. This API is available only when you use the Coherence Grid Edition.

View HotCache Member Information: Method: get
Path: /management/coherence/cluster/hotcache/members/{memberIdentifier}
View HotCache Members: Method: get
Path: /management/coherence/cluster/hotcache/members

JMX

The JMX management resource provides a set of endpoints for viewing and changing how Coherence JMX management is configured.

Update JMX Management Information: Method: post
Path: /management/coherence/cluster/management
View JMX Management Information: Method: get
Path: /management/coherence/cluster/management

Journal

The Journal resource provides a set of endpoints for managing Elastic Data journals that are used to store cache data. Use this resource to access operational information and performance statistics and to force journals to remove stale values. Cache data is aggregated across all cluster members or it can be viewed for each cluster member. This API is available only when you use the Coherence Grid Edition.

Compact a Flash Journal Member: Method: post
Path: /management/coherence/cluster/journal/flash/members/{memberIdentifier}/compact
Compact a RAM Journal Member: Method: post
Path: /management/coherence/cluster/journal/ram/members/{memberIdentifier}/compact
Compact Flash Journal: Method: post
Path: /management/coherence/cluster/journal/flash/compact
Compact RAM Journal: Method: post
Path: /management/coherence/cluster/journal/ram/compact
Flash Journal Member Information: Method: get
Path: /management/coherence/cluster/journal/flash/members/{memberIdentifier}
RAM Journal: Method: get
Path: /management/coherence/cluster/journal/ram
RAM Journal Members: Method: get
Path: /management/coherence/cluster/journal/ram/members
View Flash Journal: Method: get
Path: /management/coherence/cluster/journal/flash
View Flash Journal Members: Method: get
Path: /management/coherence/cluster/journal/flash/members
View RAM Journal Member Information: Method: get
Path: /management/coherence/cluster/journal/ram/members/{memberIdentifier}

Persistence

The Persistence resource provides a set of endpoints for managing persistence for a service. Use this resource to access operational information and to perform persistence operations.

Create a Snapshot: Method: post
Path: /management/coherence/cluster/services/{serviceName}/persistence/snapshots/{snapshotName}
Create a Snapshot across all Services: Method: post
Path: /management/coherence/cluster/services/persistence/snapshots/{snapshotName}
Create a Snapshot Archive: Method: post
Path: /management/coherence/cluster/services/{serviceName}/persistence/archives/{snapshotName}
Delete a snapshot: Method: delete
Path: /management/coherence/cluster/services/{serviceName}/persistence/snapshots/{snapshotName}
Delete a Snapshot Archive: Method: delete
Path: /management/coherence/cluster/services/{serviceName}/persistence/archives/{snapshotName}
Recover a Snapshot: Method: post
Path: /management/coherence/cluster/services/{serviceName}/persistence/snapshots/{snapshotName}/recover
Retrieve a Snapshot Archive: Method: post
Path: /management/coherence/cluster/services/{serviceName}/persistence/archives/{snapshotName}/retrieve
View Persistence Coordinator Information: Method: get
Path: /management/coherence/cluster/services/{serviceName}/persistence
View Snapshot Archive Stores: Method: get
Path: /management/coherence/cluster/services/{serviceName}/persistence/archiveStores/{snapshotName}
View Snapshot Archives: Method: get
Path: /management/coherence/cluster/services/{serviceName}/persistence/archives
View Snapshots: Method: get
Path: /management/coherence/cluster/services/{serviceName}/persistence/snapshots

Platform

The Platform resource provides a set of endpoints for managing the JVMs and operating systems on which Coherence cluster members run. Use this resource to access operational information. JVM Memory data can be aggregated across all cluster members or it can be viewed for each cluster member. When querying GarbageCollectorMXBean or MemoryPoolMXBean, use the appropriate attribute names in the path for the GC used by the JVM. As examples, we documented Parallel GC (PS) and G1 GC (G1).

View Aggregated Platform Memory: Method: get
Path: /management/coherence/cluster/platform/memory
View Compressed Class Space Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/compressedClassSpace
View G1 Codecache Manager Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/g1CodeCacheManager
View G1 Eden Space Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/g1EdenSpace
View G1 Metaspace Manager Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/g1MetaSpaceManager
View G1 Non-profiled Methods Code Heap Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/g1CodeHeapNonNMethods
View G1 Old Gen Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/g1OldGen
View G1 Old Generation Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/g1OldGeneration
View G1 Profiled Methods Code Heap Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/g1CodeHeapProfiledNMethods
View G1 Survivor Space Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/g1SurvivorSpace
View G1 Young Generation Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/g1YoungGeneration
View JVM Memory Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/memory
View Metaspace Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/metaSpace
View OS Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/operatingSystem
View PS Code Cache Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/codeCache
View PS Eden Space Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/psEdenSpace
View PS Mark Sweep Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/psMarkSweep
View PS Old Gen Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/psOldGen
View PS Scavenge Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/psScavenge
View PS Survivor Space Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/psSurvivorSpace
View Runtime Information: Method: get
Path: /management/coherence/cluster/members/{memberIdentifier}/platform/runtime

Reporter

The operations from the Reporter category.

Start the Reporter: Method: post
Path: /management/coherence/cluster/reporters/{memberIdentifier}/resetStatistics
Start the Reporter: Method: post
Path: /management/coherence/cluster/reporters/{memberIdentifier}/start
Stop the Reporter: Method: post
Path: /management/coherence/cluster/reporters/{memberIdentifier}/stop

The Search resource provides a single endpoint for searching the entire Coherence management API hierarchy.

Search the Management API: Method: post
Path: /management/coherence/cluster/search

Service

The Service resource provides a set of endpoints for managing the services that are running in a Coherence cluster. Use this resource to access operational information and performance statistics and to control the lifecycle of services. Applications should initially use this resource to discover the services in a cluster and their associated service names. Service names are required to access management resources and endpoints that are specific to a service.

Reset Service Statistics: Method: post
Path: /management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/resetStatistics
Resume a Service: Method: post
Path: /management/coherence/cluster/services/{serviceName}/resume
Shutdown a Service: Method: post
Path: /management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/shutdown
Start a Service: Method: post
Path: /management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/start
Stop a Service: Method: post
Path: /management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/stop
Suspend a Service: Method: post
Path: /management/coherence/cluster/services/{serviceName}/suspend
View Proxy Service Connection Information: Method: get
Path: /management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/proxy/connections
View Proxy Service Information: Method: get
Path: /management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/proxy
View Service Information: Method: get
Path: /management/coherence/cluster/services/{serviceName}
View Service Member Distribution State: Method: get
Path: /management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/distributionState
View Service Member Information: Method: get
Path: /management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}
View Service Member Ownership Information: Method: get
Path: /management/coherence/cluster/services/{serviceName}/members/{memberIdentifier}/ownership
View Service Members: Method: get
Path: /management/coherence/cluster/services/{serviceName}/members
View the List of Services: Method: get
Path: /management/coherence/cluster/services