Get health
GET
/api/health
const url = 'https://example.com/api/health';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/healthStatus code reports overall health (200 OK, 500 a Source/Client has issues, 503 safe mode). Status messages and filtering by type/name are only available when logged in (or the instance is not secured).
Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”type
Only report status for components of this type. Ignored when not logged in.
string
name
Only report status for the component with this name. Ignored when not logged in.
string
Responses
Section titled “Responses”Success
The request failed validation
Media typeapplication/json
The request’s body, query or params didn’t match the route’s schema
object
error
required
string
details
required
What was wrong, one entry per problem
Array<object>
object
message
required
string
path
Where the problem is, e.g. [“amount”] or [“items”, 0, “id”]
Array
Example
{ "error": "Validation failed"}