Skip to main content
Retorna o objeto health com o status atual dos serviços da Chargefy e um status geral. A consulta é pública: não exige chave de API, organização ou parâmetros.

​
Resposta

200 OK com o objeto health, inclusive quando um serviço está indisponível. Use os campos status para interpretar a saúde dos serviços; o código HTTP indica que a consulta foi respondida.
​
string
Sempre health.
​
string | null
Data e hora da última consulta válida, em ISO 8601 com fuso UTC. É null quando não há uma consulta válida disponível. Uma resposta em cache conserva esse horário.
​
object
Contém sempre os três serviços, cada um com seu próprio campo status.
​
string
Status geral dos três serviços. Prioriza major_outage, partial_outage e degraded_performance, nessa ordem. Sem uma dessas condições, retorna unknown se algum serviço estiver sem informação; caso contrário, retorna operational.

​
Status possíveis

Os mesmos valores se aplicam a cada serviço e ao status geral. Por exemplo, se auth.status for partial_outage e os outros dois serviços estiverem operational, o status geral será partial_outage.

​
Atualização

As consultas podem reutilizar a mesma observação por até 60 segundos. Quando algum serviço está unknown, esse intervalo cai para até 5 segundos. Use checked_at para identificar o horário da observação e consulte a cada 60 segundos para acompanhar mudanças. Se não houver informação válida, os três serviços e o status geral retornam unknown, com checked_at: null. O endpoint apresenta o estado atual.