Descargar especificación OpenAPI

Descarga nuestra especificación OpenAPI/Swagger para explorar nuestros endpoints de API o generar bibliotecas de cliente.

​
¿Cómo generar una clave de API?

Para generar una nueva clave de API, navega a: Menú desplegable de la organización > Configuración de la organización > Claves de API > Generar nueva clave de API.

Rootly admite tres ámbitos de claves de API:

Tipo de clave de APIPermisos
Clave de API globalLas claves de API globales se asignan al rol de On-Call y Respuesta a Incidentes cuando se generan. Los permisos del rol asignado controlan los permisos de la clave. Las claves de API globales pueden interactuar con todas las entidades dentro de tu instancia de Rootly.
Clave de API de equipoLas claves de API de equipo heredan los mismos permisos que un Administrador de Equipo. Tienen acceso completo de lectura y edición a cualquier entidad de Rootly que el equipo posea, como los Horarios y Políticas de Escalación del equipo.
Clave de API personalLas claves de API personales heredan los permisos del usuario que creó la clave de API.

​
JSON:API Specification

Rootly está utilizando la JSON:API (https://jsonapi.org) especificación:

  • JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests.
  • JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability.
  • JSON:API requires use of the JSON:API media type (application/vnd.api+json) para intercambiar datos.

​
Autenticación y solicitudes

Utilizamos la autenticación HTTP estándar sobre HTTPS para autorizar tus solicitudes.

curl --request GET \
--header 'Content-Type: application/vnd.api+json' \
--header 'Authorization: Bearer YOUR-TOKEN' \
--url https://api.rootly.com/v1/incidents

​
Limitación de tasa

  • Hay un límite predeterminado de aproximadamente 3000 GET llamadas por clave de API cada 60 segundos. El límite se calcula sobre una ventana deslizante de 60 segundos mirando hacia atrás desde el tiempo actual. Aunque el límite puede configurarse para admitir umbrales más altos, primero debes contactar a tu Gerente de Éxito del Cliente de Rootly para realizar cualquier ajuste.
  • Hay un límite predeterminado de aproximadamente 3000 PUT, POST, PATCH o DELETE llamadas por clave de API cada 60 segundos. El límite se calcula sobre una ventana deslizante de 60 segundos mirando hacia atrás desde el tiempo actual. Aunque el límite puede configurarse para admitir umbrales más altos, primero debe contactar a su Rootly Customer Success Manager para realizar cualquier ajuste.
  • La respuesta a la llamada de API devolverá el código de estado HTTP 429 - Límite de solicitudes excedido y Rootly no procesará el evento.
  • Se devolverán encabezados adicionales que le proporcionarán información sobre el límite:
    • RateLimit-Limit - El número máximo de solicitudes que se permite hacer al consumidor.
    • RateLimit-Remaining - El número de solicitudes restantes en la ventana de límite de tasa actual.
    • RateLimit-Reset - El tiempo en el que se restablece la ventana de límite de tasa actual en segundos de época UTC.

​
Paginación

  • La paginación es compatible con todos los endpoints que devuelven una colección de elementos.
  • La paginación se controla mediante el page parámetro de consulta

​
Ejemplo

curl --request GET \
--header 'Content-Type: application/vnd.api+json' \
--header 'Authorization: Bearer YOUR-TOKEN' \
--url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10