---
title: System health check
slug: system-health-check
docTags: 
createdAt: 2026-04-17T07:48:39.600Z
---

{
  "id": "Ee_WN5kHg_tqfABRKUYq4",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.archbee.com/v2/admin/system/health",
    "servers": [
      {
        "url": "https://api.archbee.com/v2/admin/system/health",
        "description": "Production server"
      },
      {
        "url": "https://staging-api.archbee.com/v2/admin/system/health",
        "description": "Staging server"
      },
      {
        "url": "https://{region}.api.archbee.com/{version}/admin/system/health",
        "description": "Regional server with variables"
      }
    ],
    "name": "System health check",
    "description": "Returns the current system health status. No auth required.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "System is healthy",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "status",
                "kind": "optional",
                "type": "string<healthy | degraded | unhealthy>",
                "description": "",
                "example": "healthy",
                "enum": [
                  "healthy",
                  "degraded",
                  "unhealthy"
                ]
              },
              {
                "name": "version",
                "kind": "optional",
                "type": "string",
                "description": "",
                "example": "2.0.0"
              },
              {
                "name": "uptime",
                "kind": "optional",
                "type": "integer",
                "description": "Uptime in seconds",
                "example": 86400
              },
              {
                "name": "services",
                "kind": "optional",
                "type": "map",
                "description": "",
                "example": "{\"database\":{\"status\":\"up\",\"latency\":5},\"cache\":{\"status\":\"up\",\"latency\":1},\"storage\":{\"status\":\"up\",\"latency\":12}}",
                "customType": "map<string, object>",
                "schema": []
              }
            ],
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "MaDh2HmQ87jRFc2qS9gIj",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.archbee.com/v2/admin/system/health \\\n     --header 'accept: application/json'"
        },
        {
          "id": "_cOfDAKpLZOFgsOnYJ3dy",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.archbee.com/v2/admin/system/health\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "7JDLXka03QdIUoJqeqPxd",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.archbee.com/v2/admin/system/health\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "jDl7qyeX3OE2rFVLHwS2t",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.archbee.com/v2/admin/system/health\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "MaDh2HmQ87jRFc2qS9gIj"
    },
    "results": {
      "languages": [
        {
          "id": "HxiHphldqajjzz5_-dpAq",
          "language": "200",
          "code": "// System is healthy\n{\n  \"status\": \"healthy\",\n  \"version\": \"2.0.0\",\n  \"uptime\": 86400,\n  \"services\": \"{\\\"database\\\":{\\\"status\\\":\\\"up\\\",\\\"latency\\\":5},\\\"cache\\\":{\\\"status\\\":\\\"up\\\",\\\"latency\\\":1},\\\"storage\\\":{\\\"status\\\":\\\"up\\\",\\\"latency\\\":12}}\"\n}"
        }
      ],
      "selectedLanguageId": "HxiHphldqajjzz5_-dpAq"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}