Healthcheck API

Buckit exposes unauthenticated endpoints for probing node uptime and cluster high availability for simple healthchecks. These endpoints return an HTTP status code indicating whether the underlying resource is healthy or satisfies read/write quorum. Buckit exposes no other data through these endpoints.

Node Liveness

Use the following endpoint to test if a Buckit server is online:

curl -I https://buckit.example.net:9000/minio/health/live

Replace https://buckit.example.net:9000 with the DNS hostname of the Buckit server to check.

A response code of 200 OK indicates the Buckit server is online and functional. Any other HTTP codes indicate an issue with reaching the server, such as a transient network issue or potential downtime.

The healthcheck probe alone cannot determine if a Buckit server is offline. Instead, the probe determines whether the current host machine can reach the server. Consider configuring a Prometheus alert using minio_cluster_health_nodes_offline_count for metrics v3 or minio_cluster_nodes_offline_total for metrics v2 to detect whether one or more Buckit nodes are offline.

Cluster Write Quorum

Use the following endpoint to test if a Buckit cluster has write quorum:

curl -I https://buckit.example.net:9000/minio/health/cluster

Replace https://buckit.example.net:9000 with the DNS hostname of a node in the Buckit cluster to check. For clusters using a load balancer to manage incoming connections, specify the hostname for the load balancer.

A response code of 200 OK indicates that the Buckit cluster has sufficient Buckit servers online to meet write quorum. A response code of 503 Service Unavailable indicates the cluster does not currently have write quorum.

The healthcheck probe alone cannot determine if a Buckit server is offline or processing write operations normally - only whether enough Buckit servers are online to meet write quorum requirements based on the configured erasure code parity. Consider configuring a Prometheus alert using one of the following metrics to detect potential issues or errors on the Buckit cluster:

minio_cluster_nodes_offline_total to alert if one or more Buckit nodes are offline.
minio_node_drive_free_bytes to alert if the cluster is running low on free drive space.

Cluster Read Quorum

Use the following endpoint to test if a Buckit cluster has read quorum:

curl -I https://buckit.example.net:9000/minio/health/cluster/read

A response code of 200 OK indicates that the Buckit cluster has sufficient Buckit servers online to meet read quorum. A response code of 503 Service Unavailable indicates the cluster does not currently have read quorum.

The healthcheck probe alone cannot determine if a Buckit server is offline or processing read operations normally - only whether enough Buckit servers are online to meet read quorum requirements based on the configured erasure code parity. Consider configuring a Prometheus alert using the minio_cluster_nodes_offline_total metric to detect whether one or more Buckit nodes are offline.

Cluster Maintenance Check

Use the following endpoint to test if the Buckit cluster can maintain both read and write if the specified Buckit server is taken down for maintenance:

curl -I https://buckit.example.net:9000/minio/health/cluster?maintenance=true

A response code of 200 OK indicates that the Buckit cluster has sufficient Buckit servers online to meet write quorum. A response code of 412 Precondition Failed indicates the cluster will lose quorum if the Buckit server goes offline.

The healthcheck probe alone cannot determine if a Buckit server is offline - only whether enough Buckit servers will be online after taking the node down for maintenance to meet read and write quorum requirements based on the configured erasure code parity. Consider configuring a Prometheus alert using the minio_cluster_nodes_offline_total metric to detect whether one or more Buckit nodes are offline.