Get health

GET /health

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • $schema string(uri)

      A URL to the JSON Schema for this object.

    • message string Required

      Human readable message.
  • default application/problem+json

    Error

    Hide response attributes Show response attributes object
    • $schema string(uri)

      A URL to the JSON Schema for this object.

    • detail string

      A human-readable explanation specific to this occurrence of the problem.

    • errors array[object] | null

      Optional list of individual error details

      Hide errors attributes Show errors attributes object
      • location string

        Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

      • message string

        Error message text

      • value

        The value at the given location

    • instance string(uri)

      A URI reference that identifies the specific occurrence of the problem.

    • status integer(int64)

      HTTP status code

    • title string

      A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

    • type string(uri)

      A URI reference to human-readable documentation for the error.

      Default value is about:blank.
GET /health 
curl \
 --request GET https://api.topktoday.dev/health
Response examples (200) 
{
  "$schema": "https://api.topktoday.dev/schemas/MessageResponseBody.json",
  "message": "All systems go!"
}
Response examples (default) 
{
  "$schema": "https://api.topktoday.dev/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}