---
title: "Verificar saúde da API"
method: GET
path: "/health"
tags: ["Health"]
---

# Verificar saúde da API

`GET /health`

## Request

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

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.

## Response `200`

API saudável — todos os componentes operacionais.

- HealthResponse: Resposta de verificação de saúde da API.
  - `status` 'healthy' | 'unhealthy', required: Status geral da API.
  - `timestamp` string, date-time, required
  - `service` string, required: Nome do serviço.
  - `components` object, required: Status individual de cada componente.
    - `dynamodb` ComponentHealth: Status de saúde de um componente individual.
      - `status` 'operational' | 'down', required: Status operacional do componente.
      - `latencyMs` number, required: Latência da verificação do componente em milissegundos.
    - `s3` ComponentHealth: Status de saúde de um componente individual.
      - `status` 'operational' | 'down', required: Status operacional do componente.
      - `latencyMs` number, required: Latência da verificação do componente em milissegundos.
    - `kms` ComponentHealth: Status de saúde de um componente individual.
      - `status` 'operational' | 'down', required: Status operacional do componente.
      - `latencyMs` number, required: Latência da verificação do componente em milissegundos.
    - `mtlsTruststore` ComponentHealth: Status de saúde de um componente individual.
      - `status` 'operational' | 'down', required: Status operacional do componente.
      - `latencyMs` number, required: Latência da verificação do componente em milissegundos.
  - `latencyMs` number, required: Latência total da verificação em milissegundos.

## Other responses

- `429`: Limite de requisições excedido.
- `500`: Erro interno do servidor.
- `503`: Serviço temporariamente indisponível.

---

[API](https://skmtc.dev/signdocs/apis/signdocs-brasil-external-api.md) · [All operations](https://skmtc.dev/signdocs/apis/signdocs-brasil-external-api/llms.txt) · [OpenAPI document](https://skmtc.dev/signdocs/apis/signdocs-brasil-external-api/revisions/2d3805aed161?raw)