Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hazelcast Health API

Liveness and readiness checks.

Hazelcast Health API is one of 5 APIs that Hazelcast publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Health. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 4 operations across 4 paths. It is described by OpenAPI 3.0.3, at version latest.

Requests are made against a single base URL, http://{host}:{port}.

4 operations 4 paths 0 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
latest
Base URL
http://localhost:5701/hazelcast/rest
Contact
Resource Areas
1

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Health 4

Liveness and readiness checks.

GET
/hazelcast/health/ready
Readiness probe
healthReady → 200503
GET
/hazelcast/health/node-state
Node state
healthNodeState → 200
GET
/hazelcast/health/cluster-state
Cluster state health
healthClusterState → 200
GET
/hazelcast/health/cluster-safe
Cluster safe
healthClusterSafe → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hazelcast-health-api-openapi.yml Raw ↑

Other APIs Hazelcast publishes across the network.

Hazelcast Cluster API
Hazelcast Configuration API
Hazelcast Maps API
Hazelcast Queues API