Skip to main content

GET Health Check

Verifica se a API e suas dependências estão no ar. Usada pelo monitoramento e pelo orquestrador de containers.

Rota pública

Esta rota é marcada como @IsPublic() — não exige Authorization nem x-api-key.


Endpoint​

GET https://api-dev.imagemais.com.br/api/health

Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/health' \
-H 'accept: application/json'

Respostas​

200 Sucesso​

Retorna o resultado do health check (formato do @nestjs/terminus), com os campos status, info, error e details.

{
"status": "ok",
"info": {
"database": {
"status": "up"
}
},
"error": {},
"details": {
"database": {
"status": "up"
}
}
}