Rootly home page
Search...
⌘K
Changelog
Blog
Overview
Overview
API Changelog
AlertEvents
GET
List alert events
POST
Create alert event
GET
Retrieve alert event
DEL
Delete alert event
PATCH
Update alert event
AlertGroups
GET
List alert groups
POST
Creates an alert group
GET
Retrieves an alert group
DEL
Delete an alert group
PATCH
Update an alert group
AlertRoutingRules
GET
List alert routing rules
POST
Creates an alert routing rule
GET
Retrieves an alert routing rule
PUT
Update an alert routing rule
DEL
Delete an alert routing rule
AlertUrgencies
GET
List alert urgencies
POST
Creates an alert urgency
GET
Retrieves an alert urgency
PUT
Update an alert urgency
DEL
Delete an alert urgency
AlertSources
GET
List alert sources
POST
Creates an alert source
GET
Retrieves an alert source
PUT
Update an alert source
DEL
Delete an alert source
Alerts
GET
List Incident alerts
POST
Attach alerts to an incident
GET
List alerts
POST
Creates an alert
GET
Retrieves an alert
PATCH
Update alert
POST
Acknowledges an alert
POST
Resolves an alert
Audits
GET
List audits
Authorizations
GET
List authorizations
POST
Creates an authorization
GET
Retrieves an authorization
PUT
Update an authorization
DEL
Delete an authorization
CatalogEntities
GET
List Catalog Entities
POST
Creates a Catalog Entity
GET
Retrieves a Catalog Entity
PUT
Update a Catalog Entity
DEL
Delete a Catalog Entity
CatalogEntityProperties
GET
List catalog properties
POST
Creates a Catalog Entity Property
GET
Retrieves a Catalog Entity Property
PUT
Update a Catalog Entity Property
DEL
Delete a Catalog Entity Property
CatalogFields
GET
List Catalog Fields
POST
Creates a Catalog Field
GET
Retrieves a Catalog Field
PUT
Update a catalog_field
DEL
Delete a catalog_field
Catalogs
GET
List catalogs
POST
Creates a catalog
GET
Retrieves a catalog
PUT
Update a catalog
DEL
Delete a catalog
Causes
GET
List causes
POST
Creates a cause
GET
Retrieves a cause
PUT
Update a cause
DEL
Delete a cause
Communications Groups
GET
Lists communications groups
POST
Creates a communications group
GET
Shows a communications group
DEL
Deletes a communications group
PATCH
Updates a communications group
Communications Stages
GET
Lists communications stages
POST
Creates a communications stage
GET
Shows a communications stage
DEL
Deletes a communications stage
PATCH
Updates a communications stage
Communications Templates
GET
Lists communications templates
POST
Creates a communications template
GET
Shows a communications template
DEL
Deletes a communications template
PATCH
Updates a communications template
Communications Types
GET
Lists communications types
POST
Creates a communications type
GET
Shows a communications type
DEL
Deletes a communications type
PATCH
Updates a communications type
[DEPRECATED] CustomFieldOptions
GET
[DEPRECATED] List custom field options
deprecated
POST
[DEPRECATED] Creates a custom field option
deprecated
GET
[DEPRECATED] Retrieves a custom field option
deprecated
PUT
[DEPRECATED] Update a custom field option
deprecated
DEL
[DEPRECATED] Delete a custom field option
deprecated
[DEPRECATED] CustomFields
GET
[DEPRECATED] List Custom Fields
deprecated
POST
[DEPRECATED] Creates a Custom Field
deprecated
GET
[DEPRECATED] Retrieves a Custom Field
deprecated
PUT
[DEPRECATED] Update a Custom Field
deprecated
DEL
[DEPRECATED] Delete a Custom Field
deprecated
CustomForms
GET
List custom forms
POST
Creates a custom form
GET
Retrieves a custom form
PUT
Update a custom form
DEL
Delete a custom form
DashboardPanels
GET
List dashboard panels
POST
Creates a dashboard panel
POST
Duplicates a dashboard panel
GET
Retrieves a dashboard panel
PUT
Update a dashboard panel
DEL
Delete a dashboard panel
Dashboards
GET
List dashboards
POST
Creates a dashboard
POST
Duplicates a dashboard
POST
Sets dashboard to user default
GET
Retrieves a dashboard
PUT
Update a dashboard
DEL
Delete a dashboard
Environments
GET
List environments
POST
Creates an environment
GET
Retrieves an environment
PUT
Update an environment
DEL
Delete an environment
EscalationPolicies
GET
List escalation policies
POST
Creates an escalation policy
GET
Retrieves an escalation policy
PUT
Update an escalation policy
DEL
Delete an escalation policy
EscalationLevelsPolicies
GET
List escalation levels for an Escalation Policy
POST
Creates an escalation level for an Escalation Policy
EscalationLevelsPath
GET
List escalation levels for an Escalation Path
POST
Creates an escalation level for an Escalation Path
EscalationLevels
GET
Retrieves an escalation level
PUT
Update an escalation level
DEL
Delete an escalation level
EscalationPaths
GET
List escalation paths
POST
Creates an escalation path
GET
Retrieves an escalation path
PUT
Update an escalation path
DEL
Delete an escalation path
FormFieldOptions
GET
List FormField Options
POST
Creates FormField Options
GET
Retrieves FormField Options
PUT
Update FormField Options
DEL
Delete FormField Options
FormFieldPlacementConditions
GET
List Form Set Conditions
POST
Creates a Form Set Condition
GET
Retrieves a Form Set Condition
PUT
Update a Form Set Condition
DEL
Delete a Form Set Condition
FormFieldPlacements
GET
List Form Field Placements
POST
Creates a Form Field Placement
GET
Retrieves a Form Field Placement
PUT
Update a Form Field Placement
DEL
Delete a Form Field Placement
FormFieldPositions
GET
List FormField Position
POST
Creates FormField Positions
GET
Retrieves a FormFieldPosition
PUT
Update a FormFieldPosition
DEL
Delete a FormFieldPosition
FormFields
GET
List Form Fields
POST
Creates a Form Field
GET
Retrieves a Form Field
PUT
Update a Form Field
DEL
Delete a Form Field
FormSetConditions
GET
List Form Set Conditions
POST
Creates a Form Set Condition
GET
Retrieves a Form Set Condition
PUT
Update a Form Set Condition
DEL
Delete a Form Set Condition
FormSets
GET
List Form Sets
POST
Creates a Form Set
GET
Retrieves a Form Set
PUT
Update a Form Set
DEL
Delete a Form Set
Functionalities
GET
List functionalities
POST
Creates a functionality
GET
Retrieves a functionality
PUT
Update a functionality
DEL
Delete a functionality
GET
Get functionality incidents chart
GET
Get functionality uptime chart
WorkflowTasks
GET
List workflow tasks
POST
Creates a workflow task
GET
Retrieves a workflow task
PUT
Update a workflow task
DEL
Delete a workflow task
[DEPRECATED] WorkflowCustomFieldSelections
GET
[DEPRECATED] List workflow custom field selections
deprecated
POST
[DEPRECATED] Creates a workflow custom field selection
deprecated
GET
[DEPRECATED] Retrieves a workflow custom field selection
deprecated
PUT
[DEPRECATED] Update a workflow custom field selection
deprecated
DEL
[DEPRECATED] Delete a workflow custom field selection
deprecated
WorkflowFormFieldConditions
GET
List workflow form field conditions
POST
Creates a workflow form field condition
GET
Retrieves a workflow form field condition
PUT
Update a workflow form field condition
DEL
Delete a workflow_form field condition
WorkflowGroups
GET
List workflow groups
POST
Creates a workflow group
GET
Retrieves a workflow group
PUT
Update a workflow group
DEL
Delete a workflow_group
WorkflowRuns
GET
List workflow runs
POST
Creates a workflow run
Workflows
GET
List workflows
POST
Creates a workflow
GET
Retrieves a workflow
PUT
Update a workflow
DEL
Delete a workflow
Heartbeats
POST
Ping a heartbeat
GET
List heartbeats
POST
Creates a heartbeat
GET
Retrieves a heartbeat
PUT
Update a heartbeat
DEL
Delete a heartbeat
IncidentActionItems
GET
List incident action items
POST
Creates an incident action item
GET
Retrieves an incident action item
PUT
Update an incident action item
DEL
Delete an incident action item
GET
List all action items for an organization
[DEPRECATED] IncidentCustomFieldSelections
GET
[DEPRECATED] List incident custom field selections
deprecated
POST
[DEPRECATED] Creates an incident custom field selection
deprecated
GET
[DEPRECATED] Retrieves an incident custom field selection
deprecated
PUT
[DEPRECATED] Update an incident custom field selection
deprecated
DEL
[DEPRECATED] Delete an incident custom field selection
deprecated
IncidentEventFunctionalities
GET
List incident event functionalities
POST
Creates an incident event functionality
GET
Retrieves an incident event functionality
PUT
Update an incident event
DEL
Delete an incident event functionality
IncidentEventServices
GET
List incident event services
POST
Creates an incident event service
GET
Retrieves an incident event service
PUT
Update an incident event
DEL
Delete an incident event functionalitu
IncidentEvents
GET
List incident events
POST
Creates an incident event
GET
Retrieves an incident event
PUT
Update an incident event
DEL
Delete an incident event
IncidentFeedbacks
GET
List incident feedbacks
POST
Creates an incident feedback
GET
Retrieves an incident feedback
PUT
Update an incident feedback
IncidentFormFieldSelections
GET
List incident form field selections
POST
Creates an incident form field selection
GET
Retrieves an incident form field selection
PUT
Update an incident form field selection
DEL
Delete an incident form field selection
IncidentPermissionSetBooleans
GET
List incident_permission_set_booleans
POST
Creates an incident_permission_set_boolean
GET
Retrieves an incident_permission_set_boolean
PUT
Update an incident_permission_set_boolean
DEL
Delete an incident_permission_set_boolean
IncidentPermissionSetResources
GET
List incident_permission_set_resources
POST
Creates an incident_permission_set_resource
GET
Retrieves an incident_permission_set_resource
PUT
Update an incident_permission_set_resource
DEL
Delete an incident_permission_set_resource
IncidentPermissionSets
GET
List incident_permission_sets
POST
Creates an incident_permission_set
GET
Retrieves an incident_permission_set
PUT
Update an incident_permission_set
DEL
Delete an incident_permission_set
IncidentRetrospectives
GET
List incident retrospectives
GET
Retrieves an incident retrospective
PUT
Update an incident retrospective
IncidentRetrospectiveSteps
GET
Retrieves an incident retrospective step
PUT
Update an incident retrospective step
IncidentRoleTasks
GET
List incident role tasks
POST
Creates an incident role task
GET
Retrieves an incident role task
PUT
Update an incident role task
DEL
Delete an incident role task
IncidentRoles
GET
List incident roles
POST
Creates an incident role
GET
Retrieves an incident role
PUT
Update an incident role
DEL
Delete an incident role
IncidentStatusPageEvents
GET
List incident status page events
POST
Creates an incident status page event
GET
Retrieves an incident status page event
PUT
Update an incident status page event
DEL
Delete an incident status page event
IncidentSubStatuses
GET
List incident_sub_statuses
POST
Creates a sub-status assignment
GET
Retrieves incident_sub_status
PUT
Update incident_sub_status
DEL
Delete an incident_sub_status
IncidentTypes
GET
List incident types
POST
Creates an incident type
GET
Retrieves an incident type
PUT
Update an incident type
DEL
Delete an incident type
Incidents
GET
List incidents
POST
Creates an incident
GET
Retrieves an incident
PUT
Update an incident
DEL
Delete an incident
PUT
Mitigate an incident
PUT
Resolve an incident
PUT
Cancel an incident
PUT
Triage an incident
PUT
Restart an incident
PUT
Mark an incident as a duplicate
POST
Add subscribers to incident
DEL
Remove subscribers from incident
POST
Assign user to incident
DEL
Remove assigned user from incident
IpRanges
GET
Retrieves IP ranges
LiveCallRouters
GET
List Live Call Routers
POST
Creates a Live Call Router
GET
Generates a phone number for Live Call Router
GET
Retrieves a Live Call Router
PUT
Update a Live Call Router
DEL
Delete a Live Call Router
OnCallRoles
GET
List On-Call Roles
POST
Creates an On-Call Role
GET
Retrieves an On-Call Role
PUT
Update an On-Call Role
DEL
Delete an On-Call Role
OnCallShadows
GET
List On Call Shadows for Shift
POST
creates an shadow configuration
GET
Retrieves an On Call Shadow configuration by ID
PUT
Update an On Call Shadow configuration
OverrideShifts
DEL
Delete an on call shadow configuration
GET
List override shifts
POST
creates an override shift
GET
Retrieves an override shift
PUT
Update an override shift
DEL
Delete an override shift
PlaybookTasks
GET
List playbook tasks
POST
Creates a playbook task
GET
Retrieves a playbook task
PUT
Update a playbook task
DEL
Delete a playbook task
Playbooks
GET
List playbooks
POST
Creates a playbook
GET
Retrieves a playbook
PUT
Update a playbook
DEL
Delete a playbook
RetrospectiveTemplates
GET
List Retrospective Templates
POST
Creates a retrospective template
GET
Retrieves a Retrospective Template
PUT
Update a Retrospective Template
DEL
Delete a Retrospective Template
Pulses
GET
List pulses
POST
Creates a pulse
GET
Retrieves a pulse
PUT
Update a pulse
RetrospectiveConfigurations
GET
List retrospective configurations
GET
Retrieves a Retrospective Configuration
PUT
Update a retrospective configuration
RetrospectiveProcessGroupSteps
GET
List RetrospectiveProcessGroup Steps
POST
Creates a retrospective process group step
GET
Retrieves a RetrospectiveProcessGroup Step
PUT
Update RetrospectiveProcessGroup Step
DEL
Delete a RetrospectiveProcessGroup Step
RetrospectiveProcessGroups
GET
List Retrospective Process Groups
POST
Creates a retrospective process group
GET
Retrieves a Retrospective Process Group
PUT
Update a Retrospective Process Group
DEL
Delete a Retrospective Process Group
RetrospectiveProcesses
GET
List retrospective processes
POST
Creates a retrospective process
GET
Retrieves a retrospective process
PUT
Update a retrospective process
DEL
Delete a retrospective process
RetrospectiveSteps
GET
List retrospective steps
POST
Creates a retrospective step
GET
Retrieves a retrospective step
PUT
Update a retrospective step
DEL
Delete a retrospective step
Roles
GET
List roles
POST
Creates a role
GET
Retrieves a role
PUT
Update a role
DEL
Delete a role
ScheduleRotationActiveDays
GET
List schedule rotation active days
POST
Creates a schedule rotation active day
GET
Retrieves a schedule rotation active day
PUT
Update a schedule rotation active day
DEL
Delete a schedule rotation active day
ScheduleRotationUsers
GET
List schedule rotation users
POST
Creates a schedule rotation user
GET
Retrieves a schedule rotation user
PUT
Update schedule rotation user
DEL
Delete a schedule rotation user
ScheduleRotations
GET
List schedule rotations
POST
Creates a schedule rotation
GET
Retrieves a schedule rotation
PUT
Update a schedule rotation
DEL
Delete a schedule rotation
Schedules
GET
List schedules
POST
Creates a schedule
GET
Retrieves a schedule
PUT
Update a schedule
DEL
Delete a schedule
Shifts
GET
Retrieves a schedule shifts
GET
List shifts
Secrets
GET
List secrets
POST
Creates a secret
GET
Retrieves a secret
PUT
Update a secret
DEL
Delete a secret
Services
GET
List services
POST
Creates a service
GET
Retrieves a service
PUT
Update a service
DEL
Delete a service
GET
Get service incidents chart
GET
Get service uptime chart
Severities
GET
List severities
POST
Creates a severity
GET
Retrieves a severity
PUT
Update a severity
DEL
Delete a severity
StatusPageTemplates
GET
List status page templates
POST
Creates a status page template
GET
Retrieves a status page template
PUT
Update status page template
DEL
Delete a incident event
StatusPages
GET
List status pages
POST
Creates a status page
GET
Retrieves a status page
PUT
Update a status page
DEL
Delete a status page
SubStatuses
GET
List Sub-Statuses
POST
Creates a Sub-Status
GET
Retrieves a Sub-Status
PUT
Update a Sub-Status
DEL
Delete a Sub-Status
Teams
GET
List teams
POST
Creates a team
GET
Retrieves a team
PUT
Update a team
DEL
Delete a team
GET
Get team incidents chart
UserEmailAddresses
GET
Retrieves user email addresses
POST
Creates a user email address
GET
Show user email address
PUT
Update user email address
DEL
Delete user email address
UserNotificationRules
GET
List user notification rules
POST
Creates an user notification rule
GET
Retrieves an user notification rule
PUT
Update an user notification rule
DEL
Delete an user notification rule
UserPhoneNumbers
GET
Retrieves user phone numbers
POST
Creates a user phone number
GET
Show user phone number
PUT
Update user phone number
DEL
Delete user phone number
Users
GET
List users
GET
Get current user
GET
Retrieves an user
PUT
Update a user
DEL
Delete an user
WebhooksDeliveries
GET
List webhook deliveries
POST
Retries a webhook delivery
GET
Retrieves a webhook delivery
WebhooksEndpoints
GET
List webhook endpoints
POST
Creates a webhook endpoint
GET
Retrieves a webhook endpoint
PUT
Update a webhook endpoint
DEL
Delete a webhook endpoint
Log In
Book a demo
English
Rootly home page
English
Search...
⌘K
Ask AI
Log In
Book a demo
Book a demo
Search...
Navigation
Overview
API Changelog
Documentation
API Reference
Integrations
Documentation
API Reference
Integrations
Overview
API Changelog
Track the latest changes and updates to the Rootly API
June 2025
June 4, 2025
fix:
user_ids[] filtering on /v1/shifts endpoint
feat:
slug field to status pages API serializer and schema
June 2, 2025
feat:
services API now accepts owner_group_ids parameter
refactor:
create reusable user response schema
fix:
action items schema for assigned_to field
fix:
ensure user contact info is created for correct user
May 2025
May 30, 2025
fix:
delete prior sourceable when updating attributes from the API
May 28, 2025
feat:
remove verification attributes from email/phone number APIs
feat:
remove primary attribute from user email addresses API
feat:
add case-insensitive target_type normalization
May 27, 2025
feat:
add RESTful API endpoints for user phone numbers and email addresses
May 26, 2025
feat:
add API support for advanced conditions in alert grouping
May 15, 2025
feat:
allow automated invite of external emails into Slack incident channels
docs:
update API schema
May 5, 2025
feat:
add new escalate targets to public API schemas
April 2025
April 30, 2025
feat:
ability to filter alerts by status via API
April 29, 2025
feat:
return API timestamps in seconds
April 21, 2025
feat:
allow internal API endpoint to accept a user_id parameter
April 18, 2025
fix:
API issue with assigning multiple users to role
feat:
include initial_delay in API serializer
April 15, 2025
fix:
allow owner_group_ids parameter in API requests
perf:
updated pagination method to accept count for large collections
April 14, 2025
perf:
updated API pagination method to avoid extra count call
April 9, 2025
fix:
add missing urgency rules to alert source serializer
April 8, 2025
feat:
add email source settings to disable threaded emails
April 4, 2025
fix:
typo in alert routes API
April 3, 2025
feat:
team and organization API keys
March 2025
March 31, 2025
refactor:
single paginate method for database queries and search
fix:
API key search in audit logs section
March 28, 2025
feat:
support resolution rule in alert source API
March 26, 2025
refactor:
consistent pagination for search and database queries
fix:
specify required fields in routing rule schema
fix:
change routing rule schema to conform to OpenAPI standards
fix:
prevent crash from invalid SQL queries
fix:
allow creating alert events with Rootly bot as user
March 25, 2025
feat:
create/update/delete alert “note” events
feat:
specify whether field can be computed in API schema
March 21, 2025
refactor:
updated alert params filtering for API controller
March 20, 2025
fix:
alert routing API issues
March 17, 2025
feat:
add API support for alert routes
docs:
fix incorrect paging strategy options
fix:
create cached Slack channel if necessary
feat:
filter schedules and escalation policies by name
fix:
validate and hydrate Slack channel targets
fix:
return 422 for invalid record exceptions
fix:
prevent duplicate active_times when updating rotation
March 14, 2025
feat:
add business hours support to escalation policy API
fix:
schedule rotation update should return errors
fix:
respect requested escalation level position (breaking change)
fix:
replace urgency rules when updating source (breaking change)
fix:
do not prevent deletion of schedule rotations (breaking change)
fix:
prevent duplicate schedule rotation active times
March 13, 2025
fix:
support for escalation level paging strategy
March 11, 2025
feat:
expose sub-status configuration on teams API
February 2025
February 26, 2025
fix:
API alert sources webhooks endpoint URL
February 25, 2025
fix:
alert sources tags and operationId API schema
feat:
add API support to mark alerts as noise
February 17, 2025
feat:
track last updated user for schedule rotations
feat:
track last updated user for schedule rotation users
February 12, 2025
feat:
API support for new escalation policy target type “team”
January 2025
January 31, 2025
docs:
add note about admin_ids to groups API schema
January 30, 2025
feat:
API support for group admin_ids
January 17, 2025
fix:
schedules slack_user_group API schema
January 10, 2025
feat:
API support for alert source urgency id and alert template
January 7, 2025
feat:
API support for email alert creation
December 2024
December 13, 2024
refactor:
update escalation policy levels controller
December 2, 2024
fix:
handle undocumented PagerDuty API schema
October 2024
October 23, 2024
feat:
on-call shift calendar subscription
October 16, 2024
docs:
improve API documentation
October 14, 2024
feat:
handle “mitigated” status for workflow tasks when sub-status enabled
feat:
add “Update Incident Status Timestamp” task to API schema
October 10, 2024
feat:
allow sub_status_id for /v1/incidents/:id endpoint
October 1, 2024
feat:
add missing API schema attribute for Terraform compatibility
September 25, 2024
feat:
API support for sub-statuses
September 16, 2024
feat:
expose alert urgency to POST api.rootly.com/v1/alerts
September 10, 2024
feat:
add alert notification target on alert updates
September 4, 2024
feat:
add API support for alert groups
August 30, 2024
feat:
add API support for alert urgency
August 29, 2024
feat:
add schedule rotation attributes to OpenAPI schema for Terraform compatibility
feat:
add escalation policy path API support
August 26, 2024
docs:
fix /v1/incidents//alerts documentation
July 19, 2024
fix:
escalation policy OpenAPI schema and add service_ids, group_ids
July 2, 2024
fix:
/api/v1/dashboards/:id returning 404 when shared publicly
Assistant
Responses are generated using AI and may contain mistakes.
Was this page helpful?
Yes
No
Previous
List alert events
List alert_events
Next
On this page
June 2025
June 4, 2025
June 2, 2025
May 2025
May 30, 2025
May 28, 2025
May 27, 2025
May 26, 2025
May 15, 2025
May 5, 2025
April 2025
April 30, 2025
April 29, 2025
April 21, 2025
April 18, 2025
April 15, 2025
April 14, 2025
April 9, 2025
April 8, 2025
April 4, 2025
April 3, 2025
March 2025
March 31, 2025
March 28, 2025
March 26, 2025
March 25, 2025
March 21, 2025
March 20, 2025
March 17, 2025
March 14, 2025
March 13, 2025
March 11, 2025
February 2025
February 26, 2025
February 25, 2025
February 17, 2025
February 12, 2025
January 2025
January 31, 2025
January 30, 2025
January 17, 2025
January 10, 2025
January 7, 2025
December 2024
December 13, 2024
December 2, 2024
October 2024
October 23, 2024
October 16, 2024
October 14, 2024
October 10, 2024
October 1, 2024
September 25, 2024
September 16, 2024
September 10, 2024
September 4, 2024
August 30, 2024
August 29, 2024
August 26, 2024
July 19, 2024
July 2, 2024