API Status Check

GET /

Returns the current status of the API and database connection

Responses

  • 200 application/json

    API status information

    Hide response attributes Show response attributes object
    • api_status string

      Values are success or failed.

    • message string
GET / 
curl \
 --request GET 'https://api.clearproxy.io/'
Response examples (200) 
{
  "message": "API is running smoothly.",
  "api_status": "success"
}
{
  "message": "API is experiencing issues.",
  "api_status": "failed"
}