0X0xinsider
System

Health check

Changed on

Returns API health status. No authentication required. Limited to 120 requests per minute per IP.

get/api/v1/health

Request

Headers

X-Query-Validation'strict'

Opt into strict query-name validation. The default is compatible: unknown names are ignored and reported in X-Query-Ignored. With strict, an unknown name returns 400 bad_request with error.reason unknown_query_parameter before the handler runs, including when its percent escape is incomplete.

If-None-Matchstring

Conditional GET validator from a previous ETag. Matching values return 304 Not Modified with an empty body.

Response

Health status

object'health' required

Changes

  • ece7a25b7a44Revision changes
    • warning

      added the new freshness_ceiling_unsatisfied enum value to the / response property for the response status

    • warning

      added the new freshness_ceiling_unsatisfied enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 8462acf80f8cRevision changes
    • warning

      added the new export_expired enum value to the / response property for the response status

    • warning

      added the new export_expired enum value to the / response property for the response status