Skip to main content

​
GET /v1/healthcheck

Returns the current health status of the Ghost Planet API. Use this endpoint to verify that the API is running and accessible.

​
Response

​
status
string
Overall API status. Returns “available” when the service is operational.
​
system_info
object
Detailed system information

​
Example Request

curl http://localhost:4000/v1/healthcheck

​
Example Response

{
  "status": "available",
  "system_info": {
    "status": "available",
    "environment": "development",
    "version": "1.0.0"
  }
}

​
Response Codes

​
200
OK
The API is healthy and operational
​
500
Internal Server Error
The API encountered an error while processing the health check

​
Usage

This endpoint is typically used for:
  • Monitoring: Automated health checks by monitoring services
  • Load Balancers: Health probe endpoints to determine service availability
  • CI/CD Pipelines: Verify deployment success
  • Development: Quick sanity check during local development
The healthcheck endpoint does not require authentication and can be called by any client.

​
Error Response

If the server encounters an error while processing the healthcheck request: 
{
  "error": "the server encountered a problem and could not process your request"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us