Overview
AlertEvents
AlertGroups
AlertRoutingRules
AlertUrgencies
AlertSources
Alerts
Audits
Authorizations
CatalogEntities
CatalogEntityProperties
CatalogFields
Catalogs
[DEPRECATED] CustomFieldOptions
[DEPRECATED] CustomFields
CustomForms
DashboardPanels
Dashboards
Environments
EscalationPolicies
EscalationLevelsPolicies
EscalationLevelsPath
EscalationLevels
EscalationPaths
FormFieldOptions
FormFieldPlacementConditions
FormFieldPlacements
FormFieldPositions
FormFields
FormSetConditions
FormSets
Functionalities
WorkflowTasks
[DEPRECATED] WorkflowCustomFieldSelections
WorkflowFormFieldConditions
WorkflowGroups
WorkflowRuns
Workflows
Heartbeats
IncidentActionItems
[DEPRECATED] IncidentCustomFieldSelections
IncidentEventFunctionalities
IncidentEventServices
IncidentEvents
IncidentFeedbacks
IncidentFormFieldSelections
IncidentPermissionSetBooleans
IncidentPermissionSetResources
IncidentPermissionSets
IncidentRetrospectives
IncidentRetrospectiveSteps
IncidentRoleTasks
IncidentRoles
IncidentStatusPageEvents
IncidentSubStatuses
IncidentTypes
Incidents
- GETList incidents
- POSTCreates an incident
- GETRetrieves an incident
- PUTUpdate an incident
- DELDelete an incident
- PUTMitigate an incident
- PUTResolve an incident
- PUTCancel an incident
- PUTTriage an incident
- PUTRestart an incident
- PUTMark an incident as a duplicate
- POSTAdd subscribers to incident
- DELRemove subscribers from incident
- POSTAssign user to incident
- DELRemove assigned user from incident
IpRanges
LiveCallRouters
OnCallRoles
OnCallShadows
OverrideShifts
PlaybookTasks
Playbooks
RetrospectiveTemplates
RetrospectiveConfigurations
RetrospectiveProcessGroupSteps
RetrospectiveProcessGroups
RetrospectiveProcesses
RetrospectiveSteps
ScheduleRotationActiveDays
ScheduleRotationUsers
ScheduleRotations
Schedules
Services
Severities
StatusPageTemplates
StatusPages
SubStatuses
Teams
UserNotificationRules
WebhooksDeliveries
Remove subscribers from incident
Remove subscribers to incident
curl --request DELETE \
--url https://api.rootly.com/v1/incidents/{id}/remove_subscribers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "incidents",
"attributes": {
"user_ids": [
"<string>"
],
"remove_users_with_no_private_incident_access": false
}
}
}'
{
"data": {
"id": "7291bc8b-b404-4c49-8aba-fb82b8324961",
"type": "incidents",
"attributes": {
"parent_incident_id": null,
"sequential_id": 1,
"title": "Voluptas earum similique natus.",
"slug": "voluptas-earum-similique-natus",
"kind": "normal",
"private": false,
"summary": "Dolorem debitis sit. Iure ipsam dolorem. Numquam temporibus itaque.",
"status": "started",
"source": "web",
"url": "http://localhost:3001/account/incidents/1-voluptas-earum-similique-natus",
"short_url": null,
"user": {
"data": {
"id": "320",
"type": "users",
"attributes": {
"name": "Reynaldo Raynor",
"email": "cleopatra_streich@davis.test",
"phone": null,
"phone_2": null,
"full_name": "Reynaldo Raynor",
"full_name_with_team": "[Sipes, Bosco and Rodriguez] Reynaldo Raynor",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-03-28T23:02:46.987-07:00",
"created_at": "2025-03-28T23:02:46.531-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "9b8fe110-ad20-49a1-b630-9c205ea60a17",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
}
}
}
},
"severity": {
"data": {
"id": "764d8831-6e9b-450d-8c67-5b13ebbfdae3",
"type": "severities",
"attributes": {
"name": "xdann",
"slug": "xdann",
"description": "Vero nam iste eos.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-03-28T23:02:46.952-07:00",
"updated_at": "2025-03-28T23:02:46.952-07:00"
}
}
},
"in_triage_by": null,
"started_by": {
"data": {
"id": "320",
"type": "users",
"attributes": {
"name": "Reynaldo Raynor",
"email": "cleopatra_streich@davis.test",
"phone": null,
"phone_2": null,
"full_name": "Reynaldo Raynor",
"full_name_with_team": "[Sipes, Bosco and Rodriguez] Reynaldo Raynor",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-03-28T23:02:46.987-07:00",
"created_at": "2025-03-28T23:02:46.531-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "9b8fe110-ad20-49a1-b630-9c205ea60a17",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
}
}
}
},
"mitigated_by": null,
"resolved_by": null,
"closed_by": null,
"cancelled_by": null,
"mitigation_message": null,
"resolution_message": null,
"cancellation_message": null,
"public_title": null,
"duplicate_incident_id": null,
"retrospective_progress_status": "not_started",
"zoom_meeting_id": null,
"zoom_meeting_start_url": null,
"zoom_meeting_join_url": null,
"zoom_meeting_password": null,
"zoom_meeting_pstn_password": null,
"zoom_meeting_h323_password": null,
"zoom_meeting_global_dial_in_numbers": [],
"shortcut_story_id": null,
"shortcut_story_url": null,
"shortcut_task_id": null,
"shortcut_task_url": null,
"asana_task_id": null,
"asana_task_url": null,
"github_issue_id": null,
"github_issue_url": null,
"gitlab_issue_id": null,
"gitlab_issue_url": null,
"jira_issue_key": null,
"jira_issue_id": null,
"jira_issue_url": null,
"google_meeting_id": null,
"google_meeting_url": null,
"trello_card_id": null,
"trello_card_url": null,
"linear_issue_id": null,
"linear_issue_url": null,
"zendesk_ticket_id": null,
"zendesk_ticket_url": null,
"motion_task_id": null,
"motion_task_url": null,
"clickup_task_id": null,
"clickup_task_url": null,
"slack_channel_name": null,
"slack_channel_id": null,
"slack_channel_url": null,
"slack_channel_short_url": null,
"slack_channel_deep_link": null,
"slack_channel_archived": false,
"slack_last_message_ts": null,
"service_now_incident_id": null,
"service_now_incident_key": null,
"service_now_incident_url": null,
"opsgenie_incident_id": null,
"opsgenie_incident_url": null,
"opsgenie_alert_id": null,
"opsgenie_alert_url": null,
"victor_ops_incident_id": null,
"victor_ops_incident_url": null,
"pagerduty_incident_id": null,
"pagerduty_incident_number": null,
"pagerduty_incident_url": null,
"mattermost_channel_id": null,
"mattermost_channel_name": null,
"mattermost_channel_url": null,
"confluence_page_id": null,
"confluence_page_url": null,
"quip_page_id": null,
"quip_page_url": null,
"airtable_base_key": null,
"airtable_table_name": null,
"airtable_record_id": null,
"airtable_record_url": null,
"google_drive_id": null,
"google_drive_parent_id": null,
"google_drive_url": null,
"sharepoint_page_id": null,
"sharepoint_page_url": null,
"datadog_notebook_id": null,
"datadog_notebook_url": null,
"freshservice_ticket_id": null,
"freshservice_ticket_url": null,
"freshservice_task_id": null,
"freshservice_task_url": null,
"scheduled_for": null,
"scheduled_until": null,
"in_triage_at": null,
"started_at": "2025-03-28T23:02:46.959-07:00",
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": null,
"resolved_at": null,
"closed_at": null,
"cancelled_at": null,
"created_at": "2025-03-28T23:02:46.959-07:00",
"updated_at": "2025-03-28T23:02:46.959-07:00",
"labels": {}
},
"relationships": {
"causes": {
"data": []
},
"subscribers": {
"data": []
},
"roles": {
"data": []
},
"environments": {
"data": []
},
"incident_types": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"events": {
"data": [
{
"id": "5dd4f190-da80-486a-90ae-77e4d37b27c9",
"type": "incident_events"
},
{
"id": "8f1c4598-ff17-41e1-b2f4-9d4d630d66e2",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
incidents
IDs of users you wish to remove from the list of subscribers for this incident
Users without read permissions for private incidents will be removed from the subscriber list of this incident
Response
Unique ID of the incident
incidents
The title of the incident
The slug of the incident
Date of creation
Date of last update
The kind of the incident
ID of parent incident
ID of duplicated incident
The summary of the incident
Create an incident as private
The Environments of the incident
The Incident Types of the incident
The Functionalities of the incident
Labels to attach to the incidents. eg: {"platform":"osx", "version": "1.29"}
Slack channel id
Slack channel name
Slack channel url
How was the incident mitigated?
How was the incident resolved?
Why was the incident cancelled?
Date of when the maintenance begins
Date of when the maintenance ends
The status of the retrospective progress
not_started
, active
, completed
, skipped
Date of triage
Date of start
Date of detection
Date of acknowledgment
Date of mitigation
Date of resolution
Date of cancellation
Was this page helpful?
curl --request DELETE \
--url https://api.rootly.com/v1/incidents/{id}/remove_subscribers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "incidents",
"attributes": {
"user_ids": [
"<string>"
],
"remove_users_with_no_private_incident_access": false
}
}
}'
{
"data": {
"id": "7291bc8b-b404-4c49-8aba-fb82b8324961",
"type": "incidents",
"attributes": {
"parent_incident_id": null,
"sequential_id": 1,
"title": "Voluptas earum similique natus.",
"slug": "voluptas-earum-similique-natus",
"kind": "normal",
"private": false,
"summary": "Dolorem debitis sit. Iure ipsam dolorem. Numquam temporibus itaque.",
"status": "started",
"source": "web",
"url": "http://localhost:3001/account/incidents/1-voluptas-earum-similique-natus",
"short_url": null,
"user": {
"data": {
"id": "320",
"type": "users",
"attributes": {
"name": "Reynaldo Raynor",
"email": "cleopatra_streich@davis.test",
"phone": null,
"phone_2": null,
"full_name": "Reynaldo Raynor",
"full_name_with_team": "[Sipes, Bosco and Rodriguez] Reynaldo Raynor",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-03-28T23:02:46.987-07:00",
"created_at": "2025-03-28T23:02:46.531-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "9b8fe110-ad20-49a1-b630-9c205ea60a17",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
}
}
}
},
"severity": {
"data": {
"id": "764d8831-6e9b-450d-8c67-5b13ebbfdae3",
"type": "severities",
"attributes": {
"name": "xdann",
"slug": "xdann",
"description": "Vero nam iste eos.",
"severity": "medium",
"color": "#E58A1F",
"position": 1,
"notify_emails": [],
"slack_channels": [],
"slack_aliases": [],
"created_at": "2025-03-28T23:02:46.952-07:00",
"updated_at": "2025-03-28T23:02:46.952-07:00"
}
}
},
"in_triage_by": null,
"started_by": {
"data": {
"id": "320",
"type": "users",
"attributes": {
"name": "Reynaldo Raynor",
"email": "cleopatra_streich@davis.test",
"phone": null,
"phone_2": null,
"full_name": "Reynaldo Raynor",
"full_name_with_team": "[Sipes, Bosco and Rodriguez] Reynaldo Raynor",
"slack_id": null,
"time_zone": "UTC",
"updated_at": "2025-03-28T23:02:46.987-07:00",
"created_at": "2025-03-28T23:02:46.531-07:00"
},
"relationships": {
"email_addresses": {
"data": [
{
"id": "9b8fe110-ad20-49a1-b630-9c205ea60a17",
"type": "user_email_addresses"
}
]
},
"phone_numbers": {
"data": []
},
"devices": {
"data": []
}
}
}
},
"mitigated_by": null,
"resolved_by": null,
"closed_by": null,
"cancelled_by": null,
"mitigation_message": null,
"resolution_message": null,
"cancellation_message": null,
"public_title": null,
"duplicate_incident_id": null,
"retrospective_progress_status": "not_started",
"zoom_meeting_id": null,
"zoom_meeting_start_url": null,
"zoom_meeting_join_url": null,
"zoom_meeting_password": null,
"zoom_meeting_pstn_password": null,
"zoom_meeting_h323_password": null,
"zoom_meeting_global_dial_in_numbers": [],
"shortcut_story_id": null,
"shortcut_story_url": null,
"shortcut_task_id": null,
"shortcut_task_url": null,
"asana_task_id": null,
"asana_task_url": null,
"github_issue_id": null,
"github_issue_url": null,
"gitlab_issue_id": null,
"gitlab_issue_url": null,
"jira_issue_key": null,
"jira_issue_id": null,
"jira_issue_url": null,
"google_meeting_id": null,
"google_meeting_url": null,
"trello_card_id": null,
"trello_card_url": null,
"linear_issue_id": null,
"linear_issue_url": null,
"zendesk_ticket_id": null,
"zendesk_ticket_url": null,
"motion_task_id": null,
"motion_task_url": null,
"clickup_task_id": null,
"clickup_task_url": null,
"slack_channel_name": null,
"slack_channel_id": null,
"slack_channel_url": null,
"slack_channel_short_url": null,
"slack_channel_deep_link": null,
"slack_channel_archived": false,
"slack_last_message_ts": null,
"service_now_incident_id": null,
"service_now_incident_key": null,
"service_now_incident_url": null,
"opsgenie_incident_id": null,
"opsgenie_incident_url": null,
"opsgenie_alert_id": null,
"opsgenie_alert_url": null,
"victor_ops_incident_id": null,
"victor_ops_incident_url": null,
"pagerduty_incident_id": null,
"pagerduty_incident_number": null,
"pagerduty_incident_url": null,
"mattermost_channel_id": null,
"mattermost_channel_name": null,
"mattermost_channel_url": null,
"confluence_page_id": null,
"confluence_page_url": null,
"quip_page_id": null,
"quip_page_url": null,
"airtable_base_key": null,
"airtable_table_name": null,
"airtable_record_id": null,
"airtable_record_url": null,
"google_drive_id": null,
"google_drive_parent_id": null,
"google_drive_url": null,
"sharepoint_page_id": null,
"sharepoint_page_url": null,
"datadog_notebook_id": null,
"datadog_notebook_url": null,
"freshservice_ticket_id": null,
"freshservice_ticket_url": null,
"freshservice_task_id": null,
"freshservice_task_url": null,
"scheduled_for": null,
"scheduled_until": null,
"in_triage_at": null,
"started_at": "2025-03-28T23:02:46.959-07:00",
"detected_at": null,
"acknowledged_at": null,
"mitigated_at": null,
"resolved_at": null,
"closed_at": null,
"cancelled_at": null,
"created_at": "2025-03-28T23:02:46.959-07:00",
"updated_at": "2025-03-28T23:02:46.959-07:00",
"labels": {}
},
"relationships": {
"causes": {
"data": []
},
"subscribers": {
"data": []
},
"roles": {
"data": []
},
"environments": {
"data": []
},
"incident_types": {
"data": []
},
"services": {
"data": []
},
"functionalities": {
"data": []
},
"groups": {
"data": []
},
"events": {
"data": [
{
"id": "5dd4f190-da80-486a-90ae-77e4d37b27c9",
"type": "incident_events"
},
{
"id": "8f1c4598-ff17-41e1-b2f4-9d4d630d66e2",
"type": "incident_events"
}
]
},
"action_items": {
"data": []
},
"custom_field_selections": {
"data": []
},
"feedbacks": {
"data": []
},
"attachments": {
"data": []
},
"slack_messages": {
"data": []
}
}
}
}