API Reference Documentation
Last updated August 29, 2024
This document serves as a comprehensive reference guide for the Rootly API, providing detailed information about available endpoints, methods, parameters, and response formats to empower developers to effectively integrate with Rootly's monitoring and incident management capabilities.
API Endpoints and Methods
- Monitors:
- GET /monitors: Retrieve a list of all monitors.
- GET /monitors/{monitor_id}: Get details of a specific monitor by its ID.
- POST /monitors: Create a new monitor.
- PUT /monitors/{monitor_id}: Update an existing monitor.
- DELETE /monitors/{monitor_id}: Delete a monitor.
- Alerts:
- GET /alerts: Retrieve a list of all alerts.
- GET /alerts/{alert_id}: Get details of a specific alert by its ID.
- POST /alerts: Create a new alert for a specific monitor.
- PUT /alerts/{alert_id}: Update an existing alert.
- DELETE /alerts/{alert_id}: Delete an alert.
- Incidents:
- GET /incidents: Retrieve a list of all incidents.
- GET /incidents/{incident_id}: Get details of a specific incident by its ID.
- PUT /incidents/{incident_id}/status: Update the status of an incident.
- Data:
- GET /monitors/{monitor_id}/data: Retrieve performance data for a specific monitor.
- Users:
- GET /users: Retrieve a list of all users.
- GET /users/{user_id}: Get details of a specific user by their ID.
- Dashboards:
- GET /dashboards: Retrieve a list of all dashboards.
- GET /dashboards/{dashboard_id}: Get details of a specific dashboard by its ID.
- POST /dashboards: Create a new dashboard.
- PUT /dashboards/{dashboard_id}: Update an existing dashboard.
- DELETE /dashboards/{dashboard_id}: Delete a dashboard.
Request Parameters
- monitor_id: ID of the monitor.
- alert_id: ID of the alert.
- incident_id: ID of the incident.
- user_id: ID of the user.
- dashboard_id: ID of the dashboard.
- status: Status of the incident (e.g., "acknowledged," "resolved").
- start_time: Timestamp (ISO 8601) for the start of the data retrieval period.
- end_time: Timestamp (ISO 8601) for the end of the data retrieval period.
Authentication and Authorization
- API Key: Your Rootly API key is required for authentication.
- Basic Authentication: The default authentication mechanism is Basic Authentication. Include your API key as a Base64 encoded string in the request headers:
- Authorization: Basic [Base64-encoded API key]
Data Formats
- JSON: Rootly API primarily uses JSON (JavaScript Object Notation) for requests and responses.
Example API Request
Was this article helpful?