Health
Liveness checks that answer without an API key, outside the /v1 prefix. Use them to tell whether the API is up.
Ping the API
GET/Answers at the API's root while it is up. It needs no API key and touches no data.
Returns
Returns an object with these fields. Status 200.
okbooleanRequiredAlways true: the API is up.
Always
trueservicestringRequiredThe service that answered, always api.
Always
apiErrors
- 400
InvalidInputThe request is malformed, or a value is not allowed.- 403
ForbiddenThe key's user or role may not do this.- 404
NotFoundThe workspace or object does not exist, or the caller cannot see it.- 409
ConflictThe change conflicts with current data, such as a slug that is already in use.- 500
InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.
GET/
curl https://api.qa.clankership.net/Response200
{ "ok": true, "service": "api"}Check the API's health
GET/Answers while the API is up, for monitors and load balancers. It needs no API key and touches no data.
Returns
Returns an object with these fields. Status 200.
okbooleanRequiredAlways true: the API is up.
Always
trueservicestringRequiredThe service that answered, always api.
Always
apiErrors
- 400
InvalidInputThe request is malformed, or a value is not allowed.- 403
ForbiddenThe key's user or role may not do this.- 404
NotFoundThe workspace or object does not exist, or the caller cannot see it.- 409
ConflictThe change conflicts with current data, such as a slug that is already in use.- 500
InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.
GET/health
curl https://api.qa.clankership.net/healthResponse200
{ "ok": true, "service": "api"}