Comprobar que la API está en marcha

GET

/v1/health

curl --request GET \
  --url https://api.iomza.com/v1/health

• Producción

Respuestas

200

{ "ok": true }.

Tipo de contenidoapplication/json

object

ok

obligatorio

Ejemplo

{
  "ok": true
}

429

Demasiadas peticiones: espera y reintenta. Lo responde la pasarela, así que el cuerpo puede ser distinto.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

500

Nuestro: reintenta, y avísanos si persiste.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

503

No disponible por un momento: reintenta en unos segundos.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}