GET
/
healthz
Get health status of the API and cluster
curl --request GET \
  --url https://api.example.com/healthz
import requests

url = "https://api.example.com/healthz"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/healthz', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/healthz",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/healthz"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/healthz")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/healthz")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "status": "<string>",
  "api": {
    "api_version": "<string>"
  },
  "backups": {
    "enabled": true,
    "target_kind": "<string>"
  },
  "boxes": {
    "pending": 1,
    "running": 1,
    "stopped": 1,
    "total": 1,
    "unknown": 1
  },
  "errors": [
    "<string>"
  ],
  "host": {
    "cpu": {
      "cores": 1,
      "load_avg_1": 123,
      "load_avg_15": 123,
      "load_avg_5": 123
    },
    "memory": {
      "available_bytes": 1,
      "total_bytes": 1,
      "used_bytes": 1,
      "used_percent": 123
    },
    "storage": {
      "available_bytes": 1,
      "path": "<string>",
      "total_bytes": 1,
      "used_bytes": 1,
      "used_percent": 123
    },
    "storage_mounts": [
      {
        "available_bytes": 1,
        "path": "<string>",
        "total_bytes": 1,
        "used_bytes": 1,
        "used_percent": 123
      }
    ]
  },
  "kubernetes": {
    "nodes": [
      {
        "cpu_allocatable": "<string>",
        "cpu_capacity": "<string>",
        "memory_allocatable_bytes": 1,
        "memory_capacity_bytes": 1,
        "name": "<string>",
        "pods_allocatable": 1,
        "pods_capacity": 1,
        "pods_running": 1,
        "ready": true
      }
    ],
    "total_pods_capacity": 1,
    "total_pods_running": 1
  },
  "namespace": "<string>"
}

Response

200 - application/json

Health status

status
string
required
api
null | object
backups
null | object

Data-volume backups are opt-in: enabled only when the deployment configures a usable backup target. Clients (and the verify suite) use this to distinguish "backups off" from "backups broken".

boxes
null | object
errors
string[] | null
host
null | object
kubernetes
null | object
namespace
string | null