Health

Verificar saúde da API

Retorna o status de saúde da API e de seus componentes internos (DynamoDB, S3, KMS, mTLS Truststore). Retorna 200 se todos os componentes estão operacionais, 503 se algum está indisponível.

get/health

Request

  • Base URL: https://api.signdocs.com.br
  • URL: https://api.signdocs.com.br/health
  • Auth: none required

Response

API saudável — todos os componentes operacionais.

status'healthy' | 'unhealthy' required

Status geral da API.

timestampstring date-time required
servicestring required

Nome do serviço.

latencyMsnumber required

Latência total da verificação em milissegundos.

Example response

{
  "service": "signdocs-external-api"
}

Changes

No recorded changes to this operation across all 1 revision of this API.