The health check endpoint provides a simple and efficient way for integrators to verify the server’s status. By sending a POST request to /api/health-check, your monitoring systems can quickly determine if the server is operational and responsive. This endpoint returns a 204 No Content status code if the server is healthy and functioning as expected. There is no need to include a request body or additional parameters. The response indicates that the server is running and ready to handle requests.

POST /api/health-check

Description:

This endpoint is used to perform a health check on the server.

Request:

Method: POST
URL: /api/health-check
Host: The Host header should match the environment variable.

Responses:

204 No Content:
The request was successful and the server is healthy. This status code indicates that no content is returned.

Example Request:

  POST /api/health-check HTTP/2
Host: example.com # Replace with your environment-specific domain

Example Response:

  HTTP/2 204 No Content

Status Codes: