---
id: healthcheck
title: "Health Check"
description: "Check the health status of the API."
sidebar_label: "Health Check"
hide_title: true
hide_table_of_contents: true
api: eJyNVm1v2zYQ/isHFig2QVa89Ju/ZZ63Bn0bYnf9kATDWTpLnClS5VFODcP/vThSih0PG/rJMnm857n3O6iANavZvarJkkejHnNVEZded0E7q2Zq3lC5hdAQNIQmNMABQ8/gNvHw5s/bQuXKdeRRXtxWaqaSZCkvVa6Yyt7rsFez+8dceeLOWSZWs4O6nk7l5yXiKqkFzQPkvlDHY65aCo0T9TUFlasOQ6Nm6irJRBy/Iy/WXGp870o0kO5VrnpvhGQI3ezqyshd4zjM3kynU3V8PBFelg21iejcua2mm14gDyrsO1IzhZ1+R3uVKy0gZRRRubLYyu3HxbtPfy8Xy+Xtp4/q0quiiWzQZXQa9KxtDQhMzPI/6SrUMVe/EnryF8jCXSyOBNVMraPQj6IklRDclmzEWMnX/xr3tSe/P9kWn/4oXBSGDpmpAmRAiNqgQ48tBfIpvNpuXMTXwUT/0dZJHqhcSVgTxJtiWkz/BRxFeyaGL7S+W80BbSWfS1duKcCaWFfEcLdYrmJmBQeddztdEXhCMwm6JZC/Djh4wlbbOgdtA3ksg94RlM4YXLuU43nU76l1gaAi3gbXwaa3pVyi0WFfPNgH++rVK5g7T7CisrHOuFoTy8UEsuyviLYc0cDtyA/ss+zBAkwgWmVoRx5rYsiy8Ro2zp+I52Dc08RgIFvuc2h03Uy+9pHGYJOwxb7SZ9YVCeId7dcOfRVFWtczAe3IBgb0BMGj5VaHQFXiJwXP2NLo5tJZS9HqSIkJW0PMJ885W4wG3wnflTh6qWvxkuSGrWDu2ra3Y86MbkiRGz0RTR+PpC/0kkoR8qRM25HWT1TURf5cTMQB10Zz05INOdzOF1CirXSFgYC+lQ3amn4uABLY+xjvBsNJQ9+JLKe4bwefXSV/bdCYNZbb6LEGbWVGbz1zPvlgTEChvtiR34dGqC8M08nWizJ6DcuBxge0WJNYkWUwgaW0KRJfeMCXb4TnSD5ykpCPBmbZnXNtlPksby/Uzj1hiAXQukpv9vFThEtng3cmOjuBlqVEOzjwzrV8BvDbUBTz9ISj4pvqn55FM3DpiaTL2Y2u+1RUnEMrROR++19pWYwAyz0HauFtGkmv4QMFr8uEcyfftItASWyYXHEgcVT6PK/QgLas6yYk/qls37onuA1wYwx8cX7LsHI1hYa8CPxSnNdiCjlDS5XGU4HFEGfZRXvJhzoUChUGzLLiwV4XFwlOlntP0iizrJPWxyFm7lpX2tPQZbLssvzO2sB5BSa73hRn+ZdlY/+TtrLRlia1R23pOchZlnL4LM5D15PUeRG4mN2/Ow+t9LqKAmrDOXjaxBkTm8amNyYmfuXKXjJtfKlyZXRJlkla/zBdbjosG4Lr2OlfDOunp6cC423hfH01POWr97fzxcflYnJdTIsmtCYOlM5xaNGeKR7SZT4sJi+GyEGJ6WTDD+88w6AM9C1cdQa1lVEa6R6G5eR+2IRkq5IVQ04OhzUyffbmeJTjNFjjZrRDr3Ets+/+8Xzd+WOxUsfjd+UqUaE=
sidebar_class_name: "get api-method"
info_path: docs/v3/api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Health Check"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/health"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Check the health status of the API.

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The API is healthy."}}}
>
  
</StatusCodes>