Health Check
Simple API call to check if the service is up and running (No authentication needed)
Last updated
Was this helpful?
Simple API call to check if the service is up and running (No authentication needed)
Last updated
Was this helpful?
The health endpoint serves as a verification mechanism for ensuring the correct functionality of AquilaX Public API End-points.
When accessed, the endpoint should respond with a JSON object containing the key-value pair {"status": "ok"} with HTTP Code 200,
indicating that all components of the service are operating as expected. This endpoint is instrumental in validating the overall health
and operational integrity of the service, enabling users to swiftly confirm its proper functioning."
Parameters: background_tasks (BackgroundTasks): An object used to add background tasks to be executed after the response is sent.
Returns: dict: A JSON object containing the following key-value pairs: - "status" (str): The health status of the service, which is "ok". - "timestamp" (float): The current timestamp. - "hostname" (str): The hostname of the server. - "ID" (int): A random integer between 1 and 1024.
/health
No body