Source code for owtf.api.handlers.health
"""
owtf.api.handlers.health
~~~~~~~~~~~~~~~~~~~~~~~~
"""
from owtf.api.handlers.base import APIRequestHandler
__all__ = ['HealthCheckHandler']
[docs]class HealthCheckHandler(APIRequestHandler):
"""API server health check"""
SUPPORTED_METHODS = ['GET']
[docs] def get(self):
"""A debug endpoint to check whether the application is alive.
**Example request**:
.. sourcecode:: http
GET /debug/health HTTP/1.1
Accept: application/json
**Example response**:
.. sourcecode:: http
HTTP/1.1 200 OK
Content-Type: application/json
{
'ok': true
}
"""
self.write({'ok': True})