Desenvolvedores · Documentação técnica
Arena Upya
API Health
Health check da API — sem autenticação. Útil para monitoramento e smoke tests.
AuthNão
Escopo—
Não exige API Key. Responde se o serviço está no ar.
Endpoints
| Método | Rota | Escopo | Descrição |
|---|---|---|---|
GET |
/api/v1/health |
— |
Status da API |
Por endpoint — assinaturas e exemplos
Health
Payload de `GET /api/v1/health` (sem auth).
| Campo | Tipo | Obrig. | Descrição |
|---|---|---|---|
ok |
boolean |
sim |
Serviço no ar. ex.: true
|
service |
string |
sim |
Nome do serviço. ex.: "arena-api"
|
version |
string |
sim |
Versão da API. ex.: "1.1.0"
|
data = Health
Exemplo
Response 2xx
{
"status": "success",
"data": {
"ok": true,
"service": "arena-api",
"version": "1.1.0"
},
"meta": {
"request_id": "a1b2c3d4e5f6789012345678"
}
}curl
curl "https://arenaupya.com.br/api/v1/health"