Skip to main content
GET
/
health
curl --location 'https://gyra-core.gyramais.com.br/health'

{
  "status": "ok",
  "info": {
    "id": "string"
  },
  "error": {
    "id": "string"
  },
  "details": {
    "id": "string"
  }
}

​
Quando usar

Use este endpoint para checagem rápida de disponibilidade da API. Você pode usar em monitoramento básico, probes de infraestrutura e validação de conectividade antes de iniciar processamentos críticos.

​
Autenticação

Sem autenticação obrigatória para esta operação. 
curl --location 'https://gyra-core.gyramais.com.br/health'

{
  "status": "ok",
  "info": {
    "id": "string"
  },
  "error": {
    "id": "string"
  },
  "details": {
    "id": "string"
  }
}

Response

The Health Check is successful

​
status
string
Example:

"ok"

​
info
object
Example:
{ "database": { "status": "up" } }
​
error
object
Example:
{}
​
details
object
Example:
{ "database": { "status": "up" } }