Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/universeclouddev/Universe/llms.txt

Use this file to discover all available pages before exploring further.

The Cluster API exposes the live membership view of the underlying Hazelcast cluster. Every node — whether a master or wrapper — is visible here along with its current resource consumption and the list of instances it is hosting. You can also use this API to send console commands to specific nodes, though remote dispatch is partially implemented (see endpoint notes). All cluster endpoints require a Bearer token with ALL permission.

​
The NodeResources Object

Resource usage is reported for each node in both list and detail responses.
​
usedRamMB
integer
Megabytes of RAM currently consumed by running instances on this node. Calculated from the sum of allocatedRamMB across all active instances.
​
usedCpu
integer
CPU units currently in use on this node. 100 units = 1 full core.

​
Endpoints

​
GET /api/cluster/nodes

Returns a list of all members currently in the Hazelcast cluster, including their network address, whether they are the local node, and their current resource usage. Authentication: ALL permission required. 
curl http://localhost:8080/api/cluster/nodes \
  -H "Authorization: Bearer YOUR_API_KEY"
Response — 200 OK An array of node objects.
​
id
string
The Hazelcast member UUID (e.g., f47ac10b-58cc-4372-a567-0e02b2c3d479).
​
name
string
Human-readable node name (the nodeId from config.json, e.g., node-1).
​
address
string
IP address of this cluster member’s Hazelcast interface.
​
port
integer
Hazelcast cluster port for this member (not the REST API port).
​
local
boolean
true if this entry represents the node that is serving this API response.
​
resources
NodeResources object
Current RAM and CPU usage on this node. See NodeResources above.
[
  {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "name": "node-1",
    "address": "127.0.0.1",
    "port": 6000,
    "local": true,
    "resources": {
      "usedRamMB": 4096,
      "usedCpu": 200
    }
  },
  {
    "id": "a1b2c3d4-e5f6-7890-ab12-cdef01234567",
    "name": "node-2",
    "address": "192.168.1.10",
    "port": 6000,
    "local": false,
    "resources": {
      "usedRamMB": 2048,
      "usedCpu": 100
    }
  }
]
StatusMeaning
200Node list returned.
401Unauthorized.

​
GET /api/cluster/nodes/

Returns detailed information about a single cluster node, including the IDs of all instances currently hosted on it. Authentication: ALL permission required. Path Parameters
​
id
string
required
The Hazelcast member UUID of the target node (e.g., f47ac10b-58cc-4372-a567-0e02b2c3d479). Use GET /api/cluster/nodes to discover member UUIDs.
curl http://localhost:8080/api/cluster/nodes/f47ac10b-58cc-4372-a567-0e02b2c3d479 \
  -H "Authorization: Bearer YOUR_API_KEY"
Response — 200 OK
​
id
string
Hazelcast member UUID.
​
name
string
Human-readable node name from config.
​
address
string
IP address of the node.
​
port
integer
Hazelcast port of the node.
​
local
boolean
Whether this node is the one handling the request.
​
resources
NodeResources object
RAM and CPU usage on this node.
​
instances
string[]
Array of 6-character instance IDs currently running on this node.
{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "name": "node-1",
  "address": "127.0.0.1",
  "port": 6000,
  "local": true,
  "resources": {
    "usedRamMB": 4096,
    "usedCpu": 200
  },
  "instances": ["a1b2c3", "d4e5f6"]
}
StatusMeaning
200Node details returned.
404No node with this UUID in the cluster.
401Unauthorized.

​
POST /api/cluster/nodes//command

Dispatches a console command to the specified cluster node. Authentication: ALL permission required. Path Parameters
​
id
string
required
The Hazelcast member UUID of the target node.
Request Body
​
command
string
required
The console command string to execute (e.g., instance list, cluster status).
curl -X POST \
  http://localhost:8080/api/cluster/nodes/a1b2c3d4-e5f6-7890-ab12-cdef01234567/command \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "instance list"}'
Remote node command execution via Hazelcast executor is not yet fully implemented. Sending a command to the local node returns a 400 directing you to use POST /api/commands/execute instead. Sending to a remote node returns 501 Not Implemented.Use POST /api/commands/execute for executing commands on the node handling your request.
StatusMeaning
400Target is the local node — use /api/commands/execute.
404Node UUID not found in cluster.
501Remote node command dispatch is not yet implemented.
401Unauthorized.

Build docs developers (and LLMs) love

Get started for freeTalk to us