Rootly API v1
How to generate an API Key? Organization dropdown > Organization Settings > API Keys JSON:API Specification Rootly is using JSON:API (https://jsonapi.org)…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
How to generate an API Key?
- Organization dropdown > Organization Settings > API Keys
JSON:API Specification
Rootly is using JSON:API (https://jsonapi.org) specification:
- 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) for exchanging data.
Authentication and Requests
We use standard HTTP Authentication over HTTPS to authorize your requests.
curl --request GET \
--header 'Content-Type: application/vnd.api+json' \
--header 'Authorization: Bearer YOUR-TOKEN' \
--url https://api.rootly.com/v1/incidentsRate limiting
- There is a default limit of 5 GET, HEAD, and OPTIONS calls per API key every 60 seconds (0 hours). The limit is calculated over a 0-hour sliding window looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your Rootly Customer Success Manager to make any adjustments.
- There is a default limit of 3 POST, PUT, PATCH or DELETE calls per API key every 60 seconds (0 hours). The limit is calculated over a 0-hour sliding window looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your Rootly Customer Success Manager to make any adjustments.
- When rate limits are exceeded, the API will return a 429 Too Many Requests HTTP status code with the response:
{"error": "Rate limit exceeded. Try again later."} - X-RateLimit headers are included in every API response, providing real-time rate limit information:
- X-RateLimit-Limit - The maximum number of requests permitted and the time window (e.g., "1000, 1000;window=3600" for 1000 requests per hour)
- X-RateLimit-Remaining - The number of requests remaining in the current rate limit window
- X-RateLimit-Used - The number of requests already made in the current window
- X-RateLimit-Reset - The time at which the current rate limit window resets, in UTC epoch seconds
Pagination
- Pagination is supported for all endpoints that return a collection of items.
- Pagination is controlled by the page query parameter
Example
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]=10Endpoints 400
AIInstructions
- GETLists team-wide AI instruction slots
/v1/ai/sre/instructionsBeta: This endpoint is in beta. Requires an API key. Team API keys are not supported. - GETShows a team-wide AI instruction slot
/v1/ai/sre/instructions/:surfaceBeta: This endpoint is in beta. Requires an API key. Team API keys are not supported. - PUTWrites a team-wide AI instruction slot
/v1/ai/sre/instructions/:surfaceBeta: This endpoint is in beta. Requires an API key. Upserts the surface slot; a blank body clears it. Team API keys are not supported. - DELETEClears a team-wide AI instruction slot
/v1/ai/sre/instructions/:surfaceBeta: This endpoint is in beta. Requires an API key. Team API keys are not supported. - PATCHPartially writes a team-wide AI instruction slot
/v1/ai/sre/instructions/:surfaceBeta: This endpoint is in beta. Requires an API key. Upserts the surface slot; a blank body clears it. Team API keys are not supported.
InvestigationRules
- GETLists investigation rules
/v1/ai/sre/investigation_rulesBeta: This endpoint is in beta. Requires an API key. Team API keys are not supported. - POSTCreates an investigation rule
/v1/ai/sre/investigation_rulesBeta: This endpoint is in beta. Requires an API key. Team API keys are not supported. - GETShows an investigation rule
/v1/ai/sre/investigation_rules/:idBeta: This endpoint is in beta. Requires an API key. Team API keys are not supported. - PUTUpdates an investigation rule
/v1/ai/sre/investigation_rules/:idBeta: This endpoint is in beta. Requires an API key. Team API keys are not supported. Omitting conditions preserves them unless resource_type changes, in… - DELETEDeletes an investigation rule
/v1/ai/sre/investigation_rules/:idBeta: This endpoint is in beta. Requires an API key. Team API keys are not supported. - PATCHPartially updates an investigation rule
/v1/ai/sre/investigation_rules/:idBeta: This endpoint is in beta. Requires an API key. Team API keys are not supported. Omitting conditions preserves them unless resource_type changes, in…
AIAutomations
- GETLists AI automation runs
/v1/ai/automations/:ai_automation_id/runsScans the 1000 most recent runs matching the filters; pagination and counts cover the visible runs in that window. When meta.next_scan_cursor is set, older… - POSTRuns an AI automation now
/v1/ai/automations/:ai_automation_id/runsRequires OAuth scope ai.automations:write. For run-now requests with incident_id, or run_id of an incident-linked run, OAuth tokens also need the… - GETGets an AI automation run
/v1/ai/automation_runs/:idIncident-linked runs are visible only when the caller's role permits access. OAuth tokens also need the ir.incidents:read scope; API keys use the key's role.… - GETLists synced Slack channels for AI Automations
/v1/ai/automations/slack_channelsChannels Rootly has synced from the team's connected Slack workspace; any returned slack_channel_id is accepted as destination_slack_channel_id. When… - GETLists Slack users for AI Automations
/v1/ai/automations/slack_usersUsers, including bots, from the team's connected Slack workspace; any returned slack_user_id is accepted by user and item_user trigger conditions. - GETLists Slack user groups for AI Automations
/v1/ai/automations/slack_user_groupsUser groups from the team's connected Slack workspace, read live from Slack; any returned slack_user_group_id is accepted by usergroup trigger conditions. - GETLists options for configuring AI Automation triggers
/v1/ai/automations/trigger_optionsReturns the source-of-truth options used by the AI Automation editor. - POSTGenerates or rotates an AI Automation webhook trigger secret
/v1/ai/automations/:id/triggers/:trigger_id/webhook_secretReturns a new secret for a webhook trigger. The previous secret stops working immediately. The secret is only returned in this response; Rootly stores a… - GETLists AI automations
/v1/ai/automationsRequires OAuth scope ai.automations:read. - POSTCreates an AI automation
/v1/ai/automationsRequires OAuth scope ai.automations:write. Read-only attributes are ignored on write. - GETGets an AI automation
/v1/ai/automations/:idRequires OAuth scope ai.automations:read. - PUTUpdates an AI automation
/v1/ai/automations/:idRequires OAuth scope ai.automations:write. Read-only attributes are ignored on write. - DELETEDeletes an AI automation
/v1/ai/automations/:idRequires OAuth scope ai.automations:write. Retires the automation: it is disabled and soft-deleted, no longer listed or runnable; GET show and run-now return… - PATCHUpdates an AI automation
/v1/ai/automations/:idRequires OAuth scope ai.automations:write. Read-only attributes are ignored on write.
AI Chat
- POSTSend AI chat message
/v1/ai/chatSend a message to the AI assistant and receive a synchronous reply. Optionally bind the conversation to an incident or alert for context-aware responses. For… - POSTStream AI chat response (SSE)
/v1/ai/chat/streamSend a message and receive the AI response as a Server-Sent Events stream. Optionally bind to an incident or alert for context. For eligible unbound home… - GETList AI home chat sessions
/v1/ai/chat/sessionsReturns the caller's active, unbound AI home chat sessions newest-first, cursor-paginated by before. archived=false leaves out archived sessions,… - GETList AI chat session messages
/v1/ai/chat/sessions/:session_id/messagesReturns the user and assistant message history for a session, paginated and chronologically ordered. Internal tool messages are filtered out. Assistant… - DELETEDelete AI chat session
/v1/ai/chat/sessions/:idPermanently deletes an AI chat session and all its messages. Requires ai.chat:write OAuth scope or an API key. - PATCHUpdate AI chat session
/v1/ai/chat/sessions/:idRenames, pins or archives an AI home chat session; a blank or null title resets to the generated title. Archiving also unpins. Requires ai.chat:write OAuth…
AISkills
- GETLists AI skill versions
/v1/ai/skills/:ai_skill_id/versionsRequires OAuth scope ai.skills:read. - GETGets an AI skill version
/v1/ai/skills/:ai_skill_id/versions/:versionRequires OAuth scope ai.skills:read. - GETLists AI skills
/v1/ai/skillsRequires OAuth scope ai.skills:read. - POSTCreates an AI skill
/v1/ai/skillsRequires OAuth scope ai.skills:write. Read-only attributes are ignored on write. - GETGets an AI skill
/v1/ai/skills/:idRequires OAuth scope ai.skills:read. - PUTUpdates an AI skill
/v1/ai/skills/:idRequires OAuth scope ai.skills:write. Read-only attributes are ignored on write. - DELETEDeletes an AI skill
/v1/ai/skills/:idRequires OAuth scope ai.skills:write. Soft-deletes the skill and removes its attachments while retaining its history. GitHub-managed skills are recreated on… - PATCHUpdates an AI skill
/v1/ai/skills/:idRequires OAuth scope ai.skills:write. Read-only attributes are ignored on write.
AIToolCallEvents
- GETLists AI tool call events
/v1/ai/tool_call_eventsReturns audit events for AI tool calls and connector calls.
AlertConfiguration
- GETRetrieves the team's alert configuration
/v1/alert_configuration - PUTUpdates the team's alert configuration
/v1/alert_configuration
AlertEvents
- GETList alert events
/v1/alerts/:alert_id/eventsList alert_events - POSTCreate alert event
/v1/alerts/:alert_id/eventsCreates a new alert event - GETList alert events across alerts
/v1/alert_eventsReturns a flat list of alert events across all alerts the requester can access. Designed for periodic polling: use page[after] with the next_cursor returned… - GETRetrieve alert event
/v1/alert_events/:idRetrieves a specific alert_event by id - DELETEDelete alert event
/v1/alert_events/:idDeletes a specific alert event. Only alert events with kind 'note' (user-created notes) can be deleted. System-generated events are immutable to maintain… - PATCHUpdate alert event
/v1/alert_events/:idUpdates a specific alert event. Only alert events with kind 'note' (user-created notes) can be updated. System-generated events are immutable to maintain…
AlertFields
- GETList alert fields
/v1/alert_fieldsList alert fields - POSTCreates an alert field
/v1/alert_fieldsCreates a new alert field from provided data - GETRetrieves an alert field
/v1/alert_fields/:idRetrieves a specific alert field by id - PUTUpdate an alert field
/v1/alert_fields/:idUpdate a specific alert field by id - DELETEDelete an alert field
/v1/alert_fields/:idDelete a specific alert field by id
AlertGroups
- GETList alert groups
/v1/alert_groupsList alert groups - POSTCreates an alert group
/v1/alert_groupsCreates a new alert group. Note: For enhanced functionality and future compatibility, consider using the advanced alert grouping with conditions field instead… - GETRetrieves an alert group
/v1/alert_groups/:idRetrieves a specific alert group by id - DELETEDelete an alert group
/v1/alert_groups/:idDelete a specific alert group by id - PATCHUpdate an alert group
/v1/alert_groups/:idUpdate a specific alert group by id. Note: For enhanced functionality and future compatibility, consider using the advanced alert grouping with conditions…
AlertRoutes
- GETList alert routes
/v1/alert_routesList all alert routes for the current team with filtering and pagination. Note: This endpoint requires access to Advanced Alert Routing. If you're unsure… - POSTCreates an alert route
/v1/alert_routesCreates a new alert route from provided data. Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this… - GETGet an alert route
/v1/alert_routes/:idGet a specific alert route by id. Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature,… - PUTUpdate an alert route
/v1/alert_routes/:idUpdate a specific alert route by id. Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature,… - DELETEDelete an alert route
/v1/alert_routes/:idDelete a specific alert route by id. Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature,… - PATCHUpdate an alert route
/v1/alert_routes/:idUpdates an alert route. Note: This endpoint requires access to Advanced Alert Routing. If you're unsure whether you have access to this feature, please…
AlertRoutingRules
- GETList alert routing rules
/v1/alert_routing_rulesList alert routing rules. Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this endpoint. If you don't… - POSTCreates an alert routing rule
/v1/alert_routing_rulesCreates a new alert routing rule from provided data. Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this… - GETRetrieves an alert routing rule
/v1/alert_routing_rules/:idRetrieves a specific alert routing rule by id. Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this… - PUTUpdate an alert routing rule
/v1/alert_routing_rules/:idUpdate a specific alert routing rule by id. Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this… - DELETEDelete an alert routing rule
/v1/alert_routing_rules/:idDelete a specific alert routing rule by id. Note: If you are an advanced alert routing user, you should use the Alert Routes endpoint instead of this…
AlertUrgencies
- GETList alert urgencies
/v1/alert_urgenciesList alert urgencies - POSTCreates an alert urgency
/v1/alert_urgenciesCreates a new alert urgency from provided data - GETRetrieves an alert urgency
/v1/alert_urgencies/:idRetrieves a specific alert urgency by id - PUTUpdate an alert urgency
/v1/alert_urgencies/:idUpdate a specific alert urgency by id - DELETEDelete an alert urgency
/v1/alert_urgencies/:idDelete a specific alert urgency by id
AlertSources
- GETList alert sources
/v1/alert_sourcesList alert sources - POSTCreates an alert source
/v1/alert_sourcesCreates a new alert source from provided data - GETRetrieves an alert source
/v1/alert_sources/:idRetrieves a specific alert source by id - PUTUpdate an alert source
/v1/alert_sources/:idUpdate a specific alert source by id - DELETEDelete an alert source
/v1/alert_sources/:idDelete a specific alert source by id
Alerts
- GETList Incident alerts
/v1/incidents/:incident_id/alertsList incident alerts - POSTAttach alerts to an incident
/v1/incidents/:incident_id/alertsAttach alerts to an incident from provided data - GETList alerts
/v1/alertsList alerts - POSTCreates an alert
/v1/alertsCreates a new alert from provided data - GETRetrieves an alert
/v1/alerts/:idRetrieves a specific alert by id - PATCHUpdate alert
/v1/alerts/:idUpdates an alert - POSTAcknowledges an alert
/v1/alerts/:id/acknowledgeAcknowledges a specific alert by id - POSTResolves an alert
/v1/alerts/:id/resolveResolves a specific alert by id - POSTSnoozes an alert
/v1/alerts/:id/snoozeSnoozes a specific alert by id, extending the acknowledgment timeout - POSTEscalates an alert
/v1/alerts/:id/escalateEscalates a specific alert to the next or specified level in its escalation policy - GETGet a receipt
/v1/alerts/receipts/:idRetrieve the delivery receipt for a notification by ID, including its state and (when applicable) failure reason and referenced resource.
API Keys
- GETList API keys
/v1/api_keysList API keys for the current organization. Returns key metadata including name, kind, expiration, and last usage — the secret token value is never included… - POSTCreates an API key
/v1/api_keysCreates a new API key and returns it with the plaintext token. The token is only returned once — store it securely, as it cannot be retrieved again. Kinds and… - GETRetrieves an API key
/v1/api_keys/:idRetrieves a specific API key by its UUID. Returns key metadata including name, kind, expiration, last usage timestamp, and the grace period status — the… - PUTUpdate an API key
/v1/api_keys/:idUpdate an API key's mutable attributes: name, description, and expires_at. The key's kind, role_id, on_call_role_id, and token cannot be changed after… - DELETERevoke an API key
/v1/api_keys/:idRevoke an API key. The key is immediately invalidated and can no longer be used for authentication. This action cannot be undone. For team and organization… - POSTRotate an API key
/v1/api_keys/:id/rotateRotate an API key's token. Issues a new secret token and returns it — the new token is only shown once, so store it securely. Self-only: You can only rotate…
Audits
- GETList audits
/v1/auditsList audits
Authorizations
- GETList authorizations
/v1/authorizationsList authorizations - POSTCreates an authorization
/v1/authorizationsCreates a new authorization from provided data - GETRetrieves an authorization
/v1/authorizations/:idRetrieves a specific authorization by id - PUTUpdate an authorization
/v1/authorizations/:idUpdate a specific authorization by id - DELETEDelete an authorization
/v1/authorizations/:idDelete a specific authorization by id
Catalog Checklist Templates
- GETList catalog checklist templates
/v1/catalog_checklist_templatesList catalog checklist templates - POSTCreates a catalog checklist template
/v1/catalog_checklist_templatesCreates a new catalog checklist template - POSTTrigger an audit for a catalog checklist template
/v1/catalog_checklist_templates/:id/triggerTriggers an audit for all applicable entities of the checklist template - GETRetrieves a catalog checklist template
/v1/catalog_checklist_templates/:idRetrieves a specific catalog checklist template by id - PUTUpdate a catalog checklist template
/v1/catalog_checklist_templates/:idUpdate a specific catalog checklist template by id - DELETEDelete a catalog checklist template
/v1/catalog_checklist_templates/:idDelete a specific catalog checklist template by id
CatalogEntities
- GETList Catalog Entities
/v1/catalogs/:catalog_id/entitiesList Catalog Entities - POSTCreates a Catalog Entity
/v1/catalogs/:catalog_id/entitiesCreates a new Catalog Entity from provided data - GETRetrieves a Catalog Entity
/v1/catalog_entities/:idRetrieves a specific Catalog Entity by id - PUTUpdate a Catalog Entity
/v1/catalog_entities/:idUpdate a specific Catalog Entity by id - DELETEDelete a Catalog Entity
/v1/catalog_entities/:idDelete a specific Catalog Entity by id - POSTBulk upsert Catalog Entities
/v1/catalogs/:catalog_id/entities/bulk_upsertCreate or update multiple catalog entities by external_id. Only attributes present in the payload are written (managed-fields semantics). Transactional: all… - POSTBulk delete Catalog Entities
/v1/catalogs/:catalog_id/entities/bulk_deleteDelete catalog entities by external_id list, or prune by managed_by source. Two mutually exclusive modes.
Catalog Entity Checklists
- GETList catalog entity checklists
/v1/catalog_entity_checklistsList catalog entity checklists - GETRetrieves a catalog entity checklist
/v1/catalog_entity_checklists/:idRetrieves a specific catalog entity checklist by id
CatalogEntityProperties
- GETList catalog properties
/v1/catalog_entities/:catalog_entity_id/propertiesDeprecated. Deprecated: This endpoint is deprecated, please use include=fields on catalog entities or native catalog endpoints (teams, services,… - POSTCreates a Catalog Entity Property
/v1/catalog_entities/:catalog_entity_id/propertiesDeprecated. Deprecated: This endpoint is deprecated, please use the fields attribute on catalog entities or native catalog endpoints (teams, services,… - GETRetrieves a Catalog Entity Property
/v1/catalog_entity_properties/:idDeprecated. Deprecated: This endpoint is deprecated, please use include=fields on catalog entities or native catalog endpoints (teams, services,… - PUTUpdate a Catalog Entity Property
/v1/catalog_entity_properties/:idDeprecated. Deprecated: This endpoint is deprecated, please use the fields attribute on catalog entities or native catalog endpoints (teams, services,… - DELETEDelete a Catalog Entity Property
/v1/catalog_entity_properties/:idDeprecated. Deprecated: This endpoint is deprecated, please use the fields attribute on catalog entities or native catalog endpoints (teams, services,…
CatalogProperties
- GETList Catalog Properties (alias for fields)
/v1/catalogs/:catalog_id/propertiesList Catalog Properties - returns catalog_properties type - POSTCreates a Catalog Property (alias for field)
/v1/catalogs/:catalog_id/propertiesCreates a new Catalog Property - returns catalog_properties type - GETRetrieves a Catalog Property (alias for field)
/v1/catalog_properties/:idRetrieves a specific Catalog Property by id - returns catalog_properties type - PUTUpdate a catalog_property (alias for field)
/v1/catalog_properties/:idUpdate a specific catalog_property by id - returns catalog_properties type - DELETEDelete a catalog_property
/v1/catalog_properties/:idDelete a specific catalog_property by id - returns catalog_properties type
Catalogs
- GETList catalogs
/v1/catalogsList catalogs - POSTCreates a catalog
/v1/catalogsCreates a new catalog from provided data - GETRetrieves a catalog
/v1/catalogs/:idRetrieves a specific catalog by id - PUTUpdate a catalog
/v1/catalogs/:idUpdate a specific catalog by id - DELETEDelete a catalog
/v1/catalogs/:idDelete a specific catalog by id
Causes
- GETList causes
/v1/causesList causes - POSTCreates a cause
/v1/causesCreates a new cause from provided data - GETRetrieves a cause
/v1/causes/:idRetrieves a specific cause by id - PUTUpdate a cause
/v1/causes/:idUpdate a specific cause by id - DELETEDelete a cause
/v1/causes/:idDelete a specific cause by id - GETList Catalog Properties
/v1/causes/propertiesList Cause Catalog Properties - POSTCreates a Catalog Property
/v1/causes/propertiesCreates a new Catalog Property from provided data
Communications Groups
- GETLists communications groups
/v1/communications/groupsLists communications groups - POSTCreates a communications group
/v1/communications/groupsCreates a new communications group from provided data - GETShows a communications group
/v1/communications/groups/:idShows details of a communications group - DELETEDeletes a communications group
/v1/communications/groups/:idDeletes a communications group - PATCHUpdates a communications group
/v1/communications/groups/:idUpdates a communications group
Communications Stages
- GETLists communications stages
/v1/communications/stagesLists communications stages - POSTCreates a communications stage
/v1/communications/stagesCreates a new communications stage from provided data - GETShows a communications stage
/v1/communications/stages/:idShows details of a communications stage - DELETEDeletes a communications stage
/v1/communications/stages/:idDeletes a communications stage - PATCHUpdates a communications stage
/v1/communications/stages/:idUpdates a communications stage
Communications Templates
- GETLists communications templates
/v1/communications/templatesLists communications templates - POSTCreates a communications template
/v1/communications/templatesCreates a new communications template from provided data - GETShows a communications template
/v1/communications/templates/:idShows details of a communications template - DELETEDeletes a communications template
/v1/communications/templates/:idDeletes a communications template - PATCHUpdates a communications template
/v1/communications/templates/:idUpdates a communications template
Communications Types
- GETLists communications types
/v1/communications/typesLists communications types - POSTCreates a communications type
/v1/communications/typesCreates a new communications type from provided data - GETShows a communications type
/v1/communications/types/:idShows details of a communications type - DELETEDeletes a communications type
/v1/communications/types/:idDeletes a communications type - PATCHUpdates a communications type
/v1/communications/types/:idUpdates a communications type
[DEPRECATED] CustomFieldOptions
- GET[DEPRECATED] List custom field options
/v1/custom_fields/:custom_field_id/optionsDeprecated. [DEPRECATED] Use form field endpoints instead. List custom field options - POST[DEPRECATED] Creates a custom field option
/v1/custom_fields/:custom_field_id/optionsDeprecated. [DEPRECATED] Use form field endpoints instead. Creates a new custom field option from provided data - GET[DEPRECATED] Retrieves a custom field option
/v1/custom_field_options/:idDeprecated. [DEPRECATED] Use form field endpoints instead. Retrieves a specific custom field option by id - PUT[DEPRECATED] Update a custom field option
/v1/custom_field_options/:idDeprecated. [DEPRECATED] Use form field endpoints instead. Update a specific custom field option by id - DELETE[DEPRECATED] Delete a custom field option
/v1/custom_field_options/:idDeprecated. [DEPRECATED] Use form field endpoints instead. Delete a specific Custom Field Option by id
[DEPRECATED] CustomFields
- GET[DEPRECATED] List Custom Fields
/v1/custom_fieldsDeprecated. [DEPRECATED] Use form field endpoints instead. List Custom fields - POST[DEPRECATED] Creates a Custom Field
/v1/custom_fieldsDeprecated. [DEPRECATED] Use form field endpoints instead. Creates a new custom field from provided data - GET[DEPRECATED] Retrieves a Custom Field
/v1/custom_fields/:idDeprecated. Retrieves a specific custom_field by id - PUT[DEPRECATED] Update a Custom Field
/v1/custom_fields/:idDeprecated. [DEPRECATED] Use form field endpoints instead. Update a specific custom field by id - DELETE[DEPRECATED] Delete a Custom Field
/v1/custom_fields/:idDeprecated. [DEPRECATED] Use form field endpoints instead. Delete a specific custom field by id
CustomForms
- GETList custom forms
/v1/custom_formsList custom forms - POSTCreates a custom form
/v1/custom_formsCreates a new custom form from provided data - GETRetrieves a custom form
/v1/custom_forms/:idRetrieves a specific custom form by id - PUTUpdate a custom form
/v1/custom_forms/:idUpdate a specific custom form by id - DELETEDelete a custom form
/v1/custom_forms/:idDelete a specific custom form by id
DashboardPanels
- GETList dashboard panels
/v1/dashboards/:dashboard_id/panelsList dashboard panels. OAuth tokens need the ir.dashboards:read scope. Panel data only includes records the token's other scopes allow (e.g.… - POSTCreates a dashboard panel
/v1/dashboards/:dashboard_id/panelsCreates a new dashboard panel from provided data. OAuth tokens need the ir.dashboards:write scope. Panel data only includes records the token's other scopes… - POSTDuplicates a dashboard panel
/v1/dashboard_panels/:id/duplicateDuplicates a dashboard panel. OAuth tokens need the ir.dashboards:write scope. Panel data only includes records the token's other scopes allow (e.g.… - GETRetrieves a dashboard panel
/v1/dashboard_panels/:idRetrieves a specific dashboard panel by id. OAuth tokens need the ir.dashboards:read scope. Panel data only includes records the token's other scopes allow… - PUTUpdate a dashboard panel
/v1/dashboard_panels/:idUpdate a specific dashboard panel by id. OAuth tokens need the ir.dashboards:write scope. Panel data only includes records the token's other scopes allow… - DELETEDelete a dashboard panel
/v1/dashboard_panels/:idDelete a specific dashboard panel by id. OAuth tokens need the ir.dashboards:write scope. Panel data only includes records the token's other scopes allow…
Dashboards
- GETList dashboards
/v1/dashboardsList dashboards. OAuth tokens need the ir.dashboards:read scope. Panel data only includes records the token's other scopes allow (e.g. ir.incidents:read,… - POSTCreates a dashboard
/v1/dashboardsCreates a new dashboard from provided data. OAuth tokens need the ir.dashboards:write scope. - POSTDuplicates a dashboard
/v1/dashboards/:id/duplicateDuplicates a dashboard. OAuth tokens need the ir.dashboards:write scope. - POSTSets dashboard to user default
/v1/dashboards/:id/set_defaultSets dashboard to user default. OAuth tokens need the ir.dashboards:write scope. - GETRetrieves a dashboard
/v1/dashboards/:idRetrieves a specific dashboard by id. OAuth tokens need the ir.dashboards:read scope. Panel data only includes records the token's other scopes allow (e.g.… - PUTUpdate a dashboard
/v1/dashboards/:idUpdate a specific dashboard by id. OAuth tokens need the ir.dashboards:write scope. - DELETEDelete a dashboard
/v1/dashboards/:idDelete a specific dashboard by id. OAuth tokens need the ir.dashboards:write scope.
Edge Connector Actions
- POSTCreate an edge connector action run
/v1/edge_connectors/:edge_connector_id/actions/:action_id/runs - GETShow an edge connector action run
/v1/edge_connectors/:edge_connector_id/actions/:action_id/runs/:id - GETList edge connector actions
/v1/edge_connectors/:edge_connector_id/actions - POSTCreate edge connector action
/v1/edge_connectors/:edge_connector_id/actions - GETShow edge connector action
/v1/edge_connectors/:edge_connector_id/actions/:id - DELETEDelete edge connector action
/v1/edge_connectors/:edge_connector_id/actions/:id - PATCHUpdate edge connector action
/v1/edge_connectors/:edge_connector_id/actions/:id
Edge Connectors
- GETList edge connectors
/v1/edge_connectors - POSTCreate edge connector
/v1/edge_connectors - GETShow edge connector
/v1/edge_connectors/:id - DELETEDelete edge connector
/v1/edge_connectors/:id - PATCHUpdate edge connector
/v1/edge_connectors/:id
Environments
- GETList environments
/v1/environmentsList environments - POSTCreates an environment
/v1/environmentsCreates a new environment from provided data - GETRetrieves an environment
/v1/environments/:idRetrieves a specific environment by id - PUTUpdate an environment
/v1/environments/:idUpdate a specific environment by id - DELETEDelete an environment
/v1/environments/:idDelete a specific environment by id - GETList Catalog Properties
/v1/environments/propertiesList Environment Catalog Properties - POSTCreates a Catalog Property
/v1/environments/propertiesCreates a new Catalog Property from provided data - POSTBulk upsert Environments
/v1/environments/bulk_upsertCreate or update multiple environments by external_id. Only attributes present in the payload are written (managed-fields semantics). Transactional: all… - POSTBulk delete Environments
/v1/environments/bulk_deleteDelete environments by external_id list, or prune by managed_by source. Two mutually exclusive modes.
EscalationPolicies
- GETList escalation policies
/v1/escalation_policiesList escalation policies - POSTCreates an escalation policy
/v1/escalation_policiesCreates a new escalation policy from provided data - GETRetrieves an escalation policy
/v1/escalation_policies/:idRetrieves a specific escalation policy by id - PUTUpdate an escalation policy
/v1/escalation_policies/:idUpdate a specific escalation policy by id - DELETEDelete an escalation policy
/v1/escalation_policies/:idDelete a specific escalation policy by id
EscalationLevelsPolicies
- GETList escalation levels for an Escalation Policy
/v1/escalation_policies/:escalation_policy_id/escalation_levelsList escalation levels - POSTCreates an escalation level for an Escalation Policy
/v1/escalation_policies/:escalation_policy_id/escalation_levelsCreates a new escalation level from provided data
EscalationLevelsPath
- GETList escalation levels for an Escalation Path
/v1/escalation_paths/:escalation_policy_path_id/escalation_levelsList escalation levels - POSTCreates an escalation level for an Escalation Path
/v1/escalation_paths/:escalation_policy_path_id/escalation_levelsCreates a new escalation level from provided data
EscalationLevels
- GETRetrieves an escalation level
/v1/escalation_levels/:idRetrieves a specific escalation level by id - PUTUpdate an escalation level
/v1/escalation_levels/:idUpdate a specific escalation level by id - DELETEDelete an escalation level
/v1/escalation_levels/:idDelete a specific escalation level by id
EscalationPaths
- GETList escalation paths
/v1/escalation_policies/:escalation_policy_id/escalation_pathsList escalation paths - POSTCreates an escalation path
/v1/escalation_policies/:escalation_policy_id/escalation_pathsCreates a new escalation path from provided data - GETRetrieves an escalation path
/v1/escalation_paths/:idRetrieves a specific escalation path by id - PUTUpdate an escalation path
/v1/escalation_paths/:idUpdate a specific escalation path by id - DELETEDelete an escalation path
/v1/escalation_paths/:idDelete a specific escalation path by id
FormFieldOptions
- GETList FormField Options
/v1/form_fields/:form_field_id/optionsList form_field_options - POSTCreates FormField Options
/v1/form_fields/:form_field_id/optionsCreates a new form_field_option from provided data - GETRetrieves FormField Options
/v1/form_field_options/:idRetrieves a specific form_field_option by id - PUTUpdate FormField Options
/v1/form_field_options/:idUpdate a specific form_field_option by id - DELETEDelete FormField Options
/v1/form_field_options/:idDelete a specific form_field_option by id
FormFieldPlacementConditionGroups
- GETList Form Field Placement Condition Groups
/v1/form_field_placements/:form_field_placement_id/condition_groupsList form_field_placement_condition_groups, each with its conditions - POSTCreates a Form Field Placement Condition Group
/v1/form_field_placements/:form_field_placement_id/condition_groupsCreates a new form_field_placement_condition_group. Add conditions to it by creating form_field_placement_conditions with its condition_group_id. - GETRetrieves a Form Field Placement Condition Group
/v1/form_field_placement_condition_groups/:idRetrieves a specific form_field_placement_condition_group by id, with its conditions - PUTUpdate a Form Field Placement Condition Group
/v1/form_field_placement_condition_groups/:idUpdate a specific form_field_placement_condition_group by id - DELETEDelete a Form Field Placement Condition Group
/v1/form_field_placement_condition_groups/:idDelete a specific form_field_placement_condition_group by id, along with its conditions
FormFieldPlacementConditions
- GETList Form Set Conditions
/v1/form_field_placements/:form_field_placement_id/conditionsList form_field_placement_conditions - POSTCreates a Form Set Condition
/v1/form_field_placements/:form_field_placement_id/conditionsCreates a new form_field_placement_condition from provided data - GETRetrieves a Form Set Condition
/v1/form_field_placement_conditions/:idRetrieves a specific form_field_placement_condition by id - PUTUpdate a Form Set Condition
/v1/form_field_placement_conditions/:idUpdate a specific form_field_placement_condition by id - DELETEDelete a Form Set Condition
/v1/form_field_placement_conditions/:idDelete a specific form_field_placement_condition by id
FormFieldPlacements
- GETList Form Field Placements
/v1/form_fields/:form_field_id/placementsList form_field_placements - POSTCreates a Form Field Placement
/v1/form_fields/:form_field_id/placementsCreates a new form_field_placement from provided data - GETRetrieves a Form Field Placement
/v1/form_field_placements/:idRetrieves a specific form_field_placement by id - PUTUpdate a Form Field Placement
/v1/form_field_placements/:idUpdate a specific form_field_placement by id - DELETEDelete a Form Field Placement
/v1/form_field_placements/:idDelete a specific form_field_placement by id
FormFieldPositions
- GETList FormField Position
/v1/form_fields/:form_field_id/positionsList form field positions - POSTCreates FormField Positions
/v1/form_fields/:form_field_id/positionsCreates a new form field_position from provided data - GETRetrieves a FormFieldPosition
/v1/form_field_positions/:idRetrieves a specific form field_position by id - PUTUpdate a FormFieldPosition
/v1/form_field_positions/:idUpdate a specific form_field position by id - DELETEDelete a FormFieldPosition
/v1/form_field_positions/:idDelete a specific form_field position by id
FormFields
- GETList Form Fields
/v1/form_fieldsList form_fields - POSTCreates a Form Field
/v1/form_fieldsCreates a new form_field from provided data - GETRetrieves a Form Field
/v1/form_fields/:idRetrieves a specific form_field by id - PUTUpdate a Form Field
/v1/form_fields/:idUpdate a specific form_field by id - DELETEDelete a Form Field
/v1/form_fields/:idDelete a specific form_field by id
FormSetConditions
- GETList Form Set Conditions
/v1/form_sets/:form_set_id/conditionsList form_set_conditions - POSTCreates a Form Set Condition
/v1/form_sets/:form_set_id/conditionsCreates a new form_set_condition from provided data - GETRetrieves a Form Set Condition
/v1/form_set_conditions/:idRetrieves a specific form_set_condition by id - PUTUpdate a Form Set Condition
/v1/form_set_conditions/:idUpdate a specific form_set_condition by id - DELETEDelete a Form Set Condition
/v1/form_set_conditions/:idDelete a specific form_set_condition by id
FormSets
- GETList Form Sets
/v1/form_setsList form_sets. Without filter[resource_type], returns incident form sets and, when Problem Management is enabled, problem form sets. Pass… - POSTCreates a Form Set
/v1/form_setsCreates a new form_set from provided data - GETRetrieves a Form Set
/v1/form_sets/:idRetrieves a specific form_set by id - PUTUpdate a Form Set
/v1/form_sets/:idUpdate a specific form_set by id - DELETEDelete a Form Set
/v1/form_sets/:idDelete a specific form_set by id
Functionalities
- GETList functionalities
/v1/functionalitiesList functionalities - POSTCreates a functionality
/v1/functionalitiesCreates a new functionality from provided data - GETRetrieves a functionality
/v1/functionalities/:idRetrieves a specific functionality by id - PUTUpdate a functionality
/v1/functionalities/:idUpdate a specific functionality by id - DELETEDelete a functionality
/v1/functionalities/:idDelete a specific functionality by id - GETGet functionality incidents chart
/v1/functionalities/:id/incidents_chart?period=stringGet functionality incidents chart - GETGet functionality uptime chart
/v1/functionalities/:id/uptime_chartGet functionality uptime chart - GETList Catalog Properties
/v1/functionalities/propertiesList Functionality Catalog Properties - POSTCreates a Catalog Property
/v1/functionalities/propertiesCreates a new Catalog Property from provided data - POSTBulk upsert Functionalities
/v1/functionalities/bulk_upsertCreate or update multiple functionalities by external_id. Only attributes present in the payload are written (managed-fields semantics). Transactional: all… - POSTBulk delete Functionalities
/v1/functionalities/bulk_deleteDelete functionalities by external_id list, or prune by managed_by source. Two mutually exclusive modes.
WorkflowTasks
- GETList workflow tasks
/v1/workflows/:workflow_id/workflow_tasksList workflow tasks - POSTCreates a workflow task
/v1/workflows/:workflow_id/workflow_tasksCreates a new workflow task from provided data - GETRetrieves a workflow task
/v1/workflow_tasks/:idRetrieves a specific workflow_task by id - PUTUpdate a workflow task
/v1/workflow_tasks/:idUpdate a specific workflow task by id - DELETEDelete a workflow task
/v1/workflow_tasks/:idDelete a specific workflow task by id
WorkflowActionItemFormFieldConditions
- GETList workflow action item form field conditions
/v1/workflows/:workflow_id/action_item_form_field_conditionsList workflow action item form field conditions - POSTCreates a workflow action item form field condition
/v1/workflows/:workflow_id/action_item_form_field_conditionsCreates a new workflow action item form field condition from provided data - GETRetrieves a workflow action item form field condition
/v1/workflow_action_item_form_field_conditions/:idRetrieves a specific workflow action item form field condition by id - PUTUpdate a workflow action item form field condition
/v1/workflow_action_item_form_field_conditions/:idUpdate a specific workflow action item form field condition by id - DELETEDelete a workflow action item form field condition
/v1/workflow_action_item_form_field_conditions/:idDelete a specific workflow action item form field condition by id
[DEPRECATED] WorkflowCustomFieldSelections
- GET[DEPRECATED] List workflow custom field selections
/v1/workflows/:workflow_id/custom_field_selectionsDeprecated. [DEPRECATED] Use form field endpoints instead. List workflow custom field selections - POST[DEPRECATED] Creates a workflow custom field selection
/v1/workflows/:workflow_id/custom_field_selectionsDeprecated. [DEPRECATED] Use form field endpoints instead. Creates a new workflow custom field selection from provided data - GET[DEPRECATED] Retrieves a workflow custom field selection
/v1/workflow_custom_field_selections/:idDeprecated. [DEPRECATED] Use form field endpoints instead. Retrieves a specific workflow custom field selection by id - PUT[DEPRECATED] Update a workflow custom field selection
/v1/workflow_custom_field_selections/:idDeprecated. [DEPRECATED] Use form field endpoints instead. Update a specific workflow custom field selection by id - DELETE[DEPRECATED] Delete a workflow custom field selection
/v1/workflow_custom_field_selections/:idDeprecated. [DEPRECATED] Use form field endpoints instead. Delete a specific workflow custom field selection by id
WorkflowFormFieldConditions
- GETList workflow form field conditions
/v1/workflows/:workflow_id/form_field_conditionsList workflow form field conditions - POSTCreates a workflow form field condition
/v1/workflows/:workflow_id/form_field_conditionsCreates a new workflow form field condition from provided data - GETRetrieves a workflow form field condition
/v1/workflow_form_field_conditions/:idRetrieves a specific workflow form field condition by id - PUTUpdate a workflow form field condition
/v1/workflow_form_field_conditions/:idUpdate a specific workflow form field condition by id - DELETEDelete a workflow_form field condition
/v1/workflow_form_field_conditions/:idDelete a specific workflow form field condition by id
WorkflowGroups
- GETList workflow groups
/v1/workflow_groupsList workflow groups - POSTCreates a workflow group
/v1/workflow_groupsCreates a new workflow group from provided data - GETRetrieves a workflow group
/v1/workflow_groups/:idRetrieves a specific workflow group by id - PUTUpdate a workflow group
/v1/workflow_groups/:idUpdate a specific workflow group by id
Showing 300 of 400 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://api.rootly.com- Authentication
- A bearer token in the Authorization header
- Operations
- 658 operations on 324 pathsGET 270POST 156PUT 107DELETE 107PATCH 18
25 marked deprecated - Main resources
- Incidents 17AIAutomations 14Meeting Recordings 13Alerts 11Functionalities 11Services 11Teams 10Environments 9AISkills 8CatalogEntities 7
- Response formats
application/vnd.api+jsonapplication/jsontext/event-stream- Description format
- OpenAPI 3.0.1, API version
v1 - Links
- OpenAPI document
- Listed from
- Rootly's published OpenAPI description (rootlyhq/rootly-go) (MIT)
How to test the Rootly API v1 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Rootly API v1 collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Lists team-wide AI instruction slots” (GET /v1/ai/sre/instructions), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Rootly API v1?
How to generate an API Key? Organization dropdown > Organization Settings > API Keys JSON:API Specification Rootly is using JSON:API (https://jsonapi.org)… It is listed under Developer tools and has 658 endpoints.
Who publishes the Rootly API v1?
It is listed from Rootly's public API description (an OpenAPI document), not published by Rootly on Swastik Codes. Anyone who controls rootly.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Rootly API v1?
Requests go to https://api.rootly.com. Endpoint paths are added to this base URL.
How do I authenticate with the Rootly API v1?
With A bearer token in the Authorization header.
How many endpoints does the Rootly API v1 have?
658 operations on 324 paths (270 GET, 156 POST, 107 PUT, 107 DELETE, 18 PATCH). The largest groups are Incidents, AIAutomations, Meeting Recordings, Alerts. This listing's collection holds the first 400.
Is forking the Rootly API v1 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.