API REST

GET /healthz

Sonda de vida

4eb9d27

GET /healthz

Sempre travado por mTLS como toda outra rota (apps/api/deploy/README.md): o Kubernetes sonda este processo por TCP puro, nunca por HTTP.

Respostas #

200 Successful Response
401 Nenhum certificado de cliente chegou a esta rota (`client_certificate_required`).
- error object obrigatório
  
  O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.
403 O CN do certificado de cliente não está em `DIAGNOS_API_ALLOWED_CLIENT_CN` (`client_certificate_cn_not_allowed`).
- error object obrigatório
  
  O corpo de toda resposta não-2xx: o que deu errado, para um programa e para uma pessoa.

curl --cert client.crt --key client.key \
  -X GET "https://api.imgexam.com/healthz" \
  -H "Content-Type: application/json"

import httpx

response = httpx.get(
    "https://api.imgexam.com/healthz",
    cert=("client.crt", "client.key"),
)
response.raise_for_status()
print(response.json())

{}

{
  "error": {
    "code": "string",
    "message": "string",
    "trace_id": {}
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "trace_id": {}
  }
}