Primeros pasos con la API de Instatus

Todos los endpoints están bajo la URL https://api.instatus.com. En general siguen la arquitectura REST.

Todas las peticiones deben codificarse en JSON con la cabecera Content-Type: application/json.

Las respuestas de la API de Instatus, incluidos los errores, también están codificadas en JSON.

Autenticación

Las peticiones a la API de Instatus deben incluir un token de API en la cabecera Authorization:

Puedes obtener tu clave de API en Ajustes de usuario → Ajustes de desarrollo

Authorization: Bearer <API_KEY>

Obtén el ID de tu página

Puedes encontrar el ID de tu página en el panel siguiendo estos pasos:

1. Ve a tu panel.
2. Haz clic derecho en tu proyecto, arriba a la izquierda, para abrir el menú.
3. Haz clic en Copiar ID del proyecto y el ID de tu página se copiará al portapapeles.

Errores

Todos los endpoints de la API devuelven un código y un mensaje dentro de las respuestas de error.

{
  "error": {
    "code": "forbidden",
    "message": "Not authorized"
  }
}

Valores de estado

Estados posibles de la página. Este es el status detallado que devuelve la API actual (v2 y posteriores). El endpoint antiguo summary.json y las notificaciones por webhook usan una forma reducida con solo UP, HASISSUES y UNDERMAINTENANCE.

• UP
• HASISSUES
• ALLUNDERMAINTENANCE
• ALLDEGRADEDPERFORMANCE
• ALLPARTIALOUTAGE
• ALLMINOROUTAGE
• ALLMAJOROUTAGE
• SOMEUNDERMAINTENANCE
• SOMEDEGRADEDPERFORMANCE
• SOMEPARTIALOUTAGE
• SOMEMINOROUTAGE
• SOMEMAJOROUTAGE
• ONEUNDERMAINTENANCE
• ONEDEGRADEDPERFORMANCE
• ONEPARTIALOUTAGE
• ONEMINOROUTAGE
• ONEMAJOROUTAGE

Estados posibles de un componente:

• OPERATIONAL
• UNDERMAINTENANCE
• DEGRADEDPERFORMANCE
• PARTIALOUTAGE
• MAJOROUTAGE

Estados posibles de una incidencia:

• INVESTIGATING
• IDENTIFIED
• MONITORING
• RESOLVED

Estados posibles de un mantenimiento:

• NOTSTARTEDYET
• INPROGRESS
• COMPLETED

Ir a los endpoints: