TOtovuk
Health

Read structured API status

Changed on

Returns structured dependency status and an agent instruction.

get/v1/status

Request

  • Base URL
    https://api.tovuk.com
  • Auth
    HTTP bearer

Response

Structured API status.

okboolean required
servicestring required
namestring required
api_versionstring required
agent_instructionstring required
docs_urlstring uri required

Example response

{
  "ok": true,
  "service": "tovuk-api",
  "name": "example",
  "api_version": "example",
  "checks": [],
  "agent_instruction": "example",
  "docs_url": "https://example.com"
}

Changes

  • ef06c3a9c42bRevision changes
    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

  • bbea75fa57fcRevision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status