health

Get the status of the API server. (No authentication required)

get/health

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/health
  • Auth: none declared

Response

Object with status ok, if the server is up and healthy

status'success' required

Example response

{
  "status": "success",
  "data": {
    "status": "ok"
  }
}

Changes

No recorded changes to this operation across all 50 revisions of this API.