Ir al contenido

El proceso responde

GET
/health
curl --request GET \
--url https://example.com/health

Vivo

Media typeapplication/json

Estado del servicio

object
status
required

Ok: el proceso responde; ready: su base de datos también responde

string
Allowed values: ok ready

Example

{
"status": "ok"
}

Error del servicio

Media typeapplication/json

Un error: un código estable para los programas y un mensaje para los desarrolladores

object
error
required

El error

object
code
required

Código estable (VALIDATION_ERROR, NOT_FOUND, INSUFFICIENT_BALANCE…)

string
message
required

Qué salió mal, para desarrolladores (puede cambiar; compare por code)

string
details

Datos que lo explican (el campo, el valor esperado…); en un error de esquema, los campos que fallaron y por qué

requestId

Id de la petición, para soporte

string

Example generated

{
"error": {
"code": "example",
"message": "example",
"details": "example",
"requestId": "example"
}
}