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 enviar una clave de API en la cabecera Authorization:

Authorization: Bearer <API_KEY>

Crea claves en Panel › Desarrolladores con Crear clave. Puedes tener varias claves, cada una con su propio nombre, como «GitHub Actions» o «Terraform». Las claves empiezan por inst_sk_.

Qué puede hacer una clave

Cada clave tiene sus propios ajustes:

  • Rol: Miembro, Editor o un rol personalizado en el plan Business. El rol decide qué puede ver y cambiar la clave, igual que con las personas. Una clave no puede ser Propietario, así que la facturación, los roles y eliminar cosas siguen en manos de personas.
  • Acceso: Ver y cambiar o Solo ver. Una clave con Solo ver no puede cambiar nada, permita lo que permita su rol.
  • Proyectos: todos los proyectos, incluidos los que añadas más adelante, o solo los que elijas.
  • Caducidad: la fecha en que la clave deja de funcionar. En el plan Free una clave puede durar hasta 90 días, en Pro hasta 1 año y en Business y Enterprise lo que quieras, incluso sin caducidad. Un propietario del equipo puede fijar un límite más corto en Ajustes del equipo › Claves de API. Las claves creadas antes de los ajustes de claves no se ven afectadas, y las claves existentes conservan su fecha cuando cambia tu plan.
  • IP permitidas: en el plan Business, la clave solo funciona desde las direcciones o rangos de IP que indiques.

Una clave pertenece al equipo o a ti:

  • Las claves de equipo siguen funcionando cuando la persona que las creó deja el equipo. Úsalas para CI, scripts e integraciones.
  • Las claves personales actúan como tú y nunca hacen más de lo que puedes hacer tú. Pueden usar Igual que tú como rol y dejan de funcionar si dejas el equipo.

Los propietarios del equipo fijan las reglas de las claves en Ajustes del equipo › Claves de API: cuánto puede durar como máximo una clave, si los miembros pueden crear claves de equipo y si se permiten claves personales.

Cuando se crea, cambia, rota o revoca una clave, aparece en la Actividad del equipo, igual que cuando se revoca una clave porque se filtró. Todo lo que se hace mediante una clave o una app conectada aparece ahí como persona mediante nombre de la clave o de la app.

Mantén tus claves seguras

  • Una clave solo se muestra una vez, cuando la creas. Cópiala en ese momento y guárdala como un secreto.
  • Para sustituir una clave, ábrela y haz clic en Rotar. Elige cuánto tiempo sigue funcionando la clave antigua, hasta 7 días, para tener tiempo de actualizar todo lo que la usa.
  • Revoca una clave desde su menú y dejará de funcionar al instante.

Las claves creadas antes de los ajustes de claves siguen funcionando igual que siempre. Aparecen como «Creada antes de los ajustes de claves» en Desarrolladores, donde puedes añadirles límites o sustituirlas por una clave nueva.

Errores de clave

Cuando una clave no puede hacer una petición, el error lleva uno de estos códigos y su mensaje indica qué cambiar.

CódigoEstadoMotivo
invalid_key401La clave no existe. Comprueba que la copiaste entera.
key_expired401La clave ha pasado su fecha de caducidad.
key_revoked401La clave fue revocada.
key_owner_left401La persona como la que actúa una clave personal dejó el equipo.
key_view_only403La clave es de Solo ver y la petición cambia algo.
role_not_allowed403El rol de la clave no puede ver ni cambiar esto.
ip_not_allowed403La petición llegó desde una dirección IP que la clave no permite.
page_not_allowed403La clave no puede usar este proyecto.
account_action_not_allowed403Las claves no pueden crear ni eliminar páginas, equipos ni espacios de trabajo. Usa el panel.
route_not_allowed403La ruta no forma parte de la API documentada.

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.
ID de la página

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: