Get public API health
Returns the current availability of the public API.
GET
Get public API health
At a glance
Operational behavior
Returns the current availability of the public API.- This public check does not validate an API key, tenant scope, or protected-resource access.
Common errors
The operation response list and Error handling page are authoritative for complete handling.
Before implementation
- Generate and log a new
X-Request-IDfor the attempt. - Handle every documented response status.
- Do not log
X-API-Keyor unnecessary personal data. - Reconcile current resource state before replaying an ambiguous write.
Related integration guidance
Review the complete process, state, retry, and operational pattern for this operation.
Headers
Optional request identifier. If supplied, it must be a UUID v4 or v7 and is returned unchanged in every response. If omitted, the API generates one. Invalid values return 400 INVALID_REQUEST_ID. If your client uses a {{requestId}} variable, refresh it with a new UUID version 4 or 7 for every HTTP request attempt. Keep the header disabled to let the API generate the request identifier.
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[47][0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$Response
The public API is available.
Availability status returned when the public API is healthy.
Last modified on August 27, 2026
