Send Requests

Use the following guidelines when sending requests using the Oracle Coherence management REST API.

Standalone Coherence URL Structure

Access the Oracle Coherence management REST resources using the following URL structure:
http://<host>:<port>/management/coherence/<resource-path>
Where:
  • <host>:<port> is the host and port where the HTTP management server is running in the cluster.
  • <resource-path> is the relative path that defines the resource. For a complete list of resources, see REST Endpoints.

Managed Coherence URL Structure

Access the Oracle Coherence management REST resources in a WebLogic Server domain using the following URL structure:
https://<admin-host>:<admin-port>/management/coherence/<version>/clusters/<cluster-name>/<resource-path>

Where:

  • <admin-host>:<admin-port> is the WebLogic Administration Server host and port.
  • <version> is the WebLogic Server version or simply latest.
  • <cluster-name> is a Coherence cluster in the domain. If you omit the cluster name, then a list of Coherence clusters in the domain is returned.
  • <resource-path> is the relative path that defines the resource. For a complete list of resources, see REST Endpoints.

Supported Methods

The Coherence management REST API is primarily used for viewing management data and changing operational settings. The REST API uses standard HTTP method requests, as summarized in the following table:

HTTP Method Description
GET View management information for Coherence resources. Management information is typically viewed in the context of a specific cluster member, service, or cache. Some resources also support aggregated views of the management information.
POST Change the operational settings for Coherence resources. Some resources support an expanded list of operations for performing administrative tasks.
DELETE Delete a persistence snapshot or snapshot archive.

Note:

After a shutdown or stop operation, a cluster member and its services may be restarted if it is monitored and its services are configured to start automatically.

Media Types

The following media types are supported by the Coherence management REST API:

  • application/json

Supported Headers

The Oracle Coherence management REST API does not currently use parameters in the header section of the HTTP request or response.