fleet-memory/hindsight-docs/docs/api-reference/endpoints/health-endpoint-health-get.api.mdx
2025-12-09 10:02:14 +01:00

63 lines
No EOL
1.8 KiB
Text

---
id: health-endpoint-health-get
title: "Health check endpoint"
description: "Checks the health of the API and database connection"
sidebar_label: "Health check endpoint"
hide_title: true
hide_table_of_contents: true
api: eJydUk1v2zAM/SsCz5rt5ehbUQRLgLUoluxkBIUqM5ZaW9IkOplh+L8PtN31Y7f5Iovi43vk4wikmgRlBXfeWfLRugZOEmpMOtpA1jso4dagfkmCDAqDqiUj/Hm+3TzshXK1qBWpJ5VQaO8c6hkmwQeMiv/3NZSwIB/R1cFbR4/rvUECCRFT8C5hgnKETVHw8VHDodcaUzr3rfixJoME7R2hI05XIbRWz3z5c2LMCEkb7BSU48SfhA7JeBazsAZFBkrIFykgwbqzZxxZahFK2FlXJ9sYErvj8YHbhc+zeX0QZx/F3/xVmtKzNKc6rnaHnY+DOAyJsINJQms1ch9vKTdBaYNikxUgoY8tz40opDLPr9drpubnzMcmX7Ep/76/3d4ftl82WZEZ6loufMGYFnlfsyIrOBR8ok65d1y7xUrN5opXWz73N76N+H/XgIbAdIS/KQ+tso7lzL2NqwPVuhy8ecYn4sg4cqWfsZ0mDv/qMQ5QVicJFxWtemJ/qtMkGVpjhLIa4QUHnqHWGLiRi2p7Zv5nM6bTu1X4tj3CNP0BgNwIYQ==
sidebar_class_name: "get api-method"
info_path: docs/api-reference/endpoints/hindsight-http-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 endpoint"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/health"}
context={"endpoint"}
>
</MethodEndpoint>
Checks the health of the API and database connection
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}
>
</StatusCodes>