Utilities
API Health Check Endpoint.
This method provides an endpoint to verify the health status of the API and its underlying infrastructure. It checks various dependencies such as the database and storage capabilities, reports on the available disk space, latency, and API version details. Based on these checks, it will return a status indicating the health of the API.
Key Return Values:
- 'OK': Indicates that the component or dependency is functioning correctly.
- 'Error': Signifies that there's an issue with that particular component or dependency.
get/api/v1/health
Request
- Base URL: https://atisgenerator.com
- URL: https://atisgenerator.com/api/v1/health
- Auth: none declared
Response
Get API Health Check status.
Example response
{
"status": "ok",
"message": "API v1 is up and running!",
"code": 200,
"data": {
"uptime": "3 days 2 hours",
"timestamp": "2021-01-01 00:00:00",
"app_version": "1.0.0",
"api_version": "v1",
"diskspace": 50,
"latency": 0.123
},
"dependencies": {
"database": "OK",
"storage": "OK"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.