Status Check API

Status Check API

This API checks the operational status of the application to ensure it is running and accessible. It is particularly useful for debugging connectivity and server health issues.

API Endpoint

GET /api/v1/status


Info
## Important Notes:
- All API requests must be made to this base URL followed by the specific endpoint path
- HTTPS protocol is required for all API calls
- API version v1 is currently supported
- All responses will be returned in JSON format

Headers

  • Authorization: Bearer <Access-Token> (Optional, depending on your implementation. For example, if you require authentication for all endpoints.)

Response

When the API is operational and the request is successful, it will return a JSON object indicating its status:

Notes
{
    "status": "success",
    "message": "API is up and running",
    "timestamp": "3/29/2024 11:08:43 AM"
}

API Error Handling

Invalid token


Notes
{
    "status": "error",
    "message": "Unauthorized",
    "errors": {
        "authorization": "Token is invalid or expired"
    }
}