QuireRead platform system health
Returns every service, queue and dependency check with its state, latency, what was measured and what to do about it. Message ids carry their values so a client can render them in its own language; an English rendering is returned beside them. Connection strings and credentials are omitted.
Quire permissions
Required capability: platform/health_view.
Credential scopes: tenants:read.
The acting subject must also be allowed to perform this action in the organisation.
https://your-organisation.quirelms.com/api/v1/platform/system_healthAuthorisation
Header parameters
Returns
200
Success.
- checked_atstringrequiredformat: date-time, pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
401
The credential is missing, malformed, expired or revoked.
403
The credential lacks the scope this operation requires, or the acting subject lacks the capability.
422
The request was understood and its content is not valid. errors names each field.
429
A rate limit or a concurrency cap was reached. Retry-After says when to try again.
500
Something failed at our end. Quote request_id when reporting it.