Skip to main content
PUT
/
v1
/
incidents
/
{id}
/
cancel
Cancel an incident
curl --request PUT \
  --url https://api.rootly.com/v1/incidents/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "incidents",
    "attributes": {
      "cancellation_message": "<string>"
    }
  }
}
'
{
  "data": {
    "id": "583b570e-5d04-4bfb-b1a3-3093cc0328b1",
    "type": "incidents",
    "attributes": {
      "parent_incident_id": null,
      "sequential_id": 1,
      "title": "Placeat tempora inventore et.",
      "slug": "placeat-tempora-inventore-et",
      "kind": "normal",
      "private": false,
      "summary": "Reiciendis cum id. Molestias fuga doloribus. Vel voluptatem voluptas.",
      "status": "cancelled",
      "source": "web",
      "url": "http://localhost:3001/account/incidents/1-placeat-tempora-inventore-et",
      "short_url": null,
      "user": {
        "data": {
          "id": "619",
          "type": "users",
          "attributes": {
            "name": "Otha Hyatt",
            "email": "[email protected]",
            "phone": null,
            "phone_2": null,
            "first_name": "Otha",
            "last_name": "Hyatt",
            "full_name": "Otha Hyatt",
            "full_name_with_team": "[Mraz and Sons] Otha Hyatt",
            "slack_id": null,
            "time_zone": "Etc/UTC",
            "updated_at": "2026-01-21T18:29:06.192-08:00",
            "created_at": "2026-01-21T18:29:05.126-08:00"
          },
          "relationships": {
            "email_addresses": {
              "data": [
                {
                  "id": "9e41ce9a-3942-4e1a-a64a-d5ac89553f85",
                  "type": "user_email_addresses"
                }
              ]
            },
            "phone_numbers": {
              "data": []
            },
            "devices": {
              "data": []
            },
            "role": {
              "data": {
                "id": "3d5b2a7b-0842-494a-8f63-c748858babe2",
                "alerts_permissions": [
                  "create",
                  "read"
                ],
                "api_keys_permissions": [
                  "create",
                  "update",
                  "read",
                  "delete"
                ],
                "audits_permissions": [],
                "billing_permissions": [],
                "catalogs_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "communication_permissions": [
                  "read"
                ],
                "created_at": "2026-01-21T18:29:04.434-08:00",
                "deleted_at": null,
                "display_order": 2,
                "edge_connector_permissions": [],
                "environments_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "form_fields_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "functionalities_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "groups_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_causes_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_communication_permissions": [
                  "read"
                ],
                "incident_feedbacks_permissions": [
                  "read",
                  "create",
                  "update"
                ],
                "incident_permission_set_id": "27e4595e-fe60-485d-8a4c-d9b8ee7fb2d2",
                "incident_roles_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_types_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incidents_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "integrations_permissions": [],
                "invitations_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "is_deletable": false,
                "is_editable": true,
                "name": "user",
                "paging_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "playbooks_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "private_incidents_permissions": [],
                "pulses_permissions": [
                  "create",
                  "update",
                  "read"
                ],
                "retrospective_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "roles_permissions": [],
                "secrets_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "services_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "severities_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "slug": "user",
                "status_pages_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "sub_statuses_permissions": [
                  "read"
                ],
                "team_id": 383,
                "updated_at": "2026-01-21T18:29:04.434-08:00",
                "webhooks_permissions": [],
                "workflows_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ]
              }
            },
            "on_call_role": {
              "data": {
                "id": "69482b9d-42ee-42fb-aaf7-e5b0b01fa857",
                "alert_fields_permissions": [],
                "alert_groups_permissions": [],
                "alert_routing_rules_permissions": [],
                "alert_sources_permissions": [],
                "alert_urgency_permissions": [],
                "alerts_permissions": [],
                "api_keys_permissions": [],
                "audits_permissions": [],
                "contacts_permissions": [],
                "created_at": "2026-01-21T18:29:04.460-08:00",
                "deleted_at": null,
                "escalation_policies_permissions": [],
                "groups_permissions": [],
                "heartbeats_permissions": [],
                "integrations_permissions": [],
                "invitations_permissions": [],
                "live_call_routing_permissions": [],
                "name": "None",
                "on_call_readiness_report_permissions": [],
                "on_call_roles_permissions": [],
                "schedule_override_permissions": [],
                "schedules_permissions": [],
                "services_permissions": [],
                "shift_overrides_permissions": [],
                "slug": "none",
                "system_role": "no_access",
                "team_id": 383,
                "updated_at": "2026-01-21T18:29:04.460-08:00",
                "webhooks_permissions": [],
                "workflows_permissions": []
              }
            },
            "teams": {
              "data": []
            },
            "schedules": {
              "data": []
            },
            "notification_rules": {
              "data": [
                {
                  "id": "86203c88-4864-460b-83c8-d2cf815991b6",
                  "type": "user_notification_rules"
                },
                {
                  "id": "e08151cf-bd66-469d-9a3d-b5f00e993803",
                  "type": "user_notification_rules"
                }
              ]
            }
          }
        }
      },
      "severity": {
        "data": {
          "id": "2d0484e8-ab79-469c-b519-e10a82f89baf",
          "type": "severities",
          "attributes": {
            "name": "5dfds",
            "slug": "5dfds",
            "description": "Quo deleniti dolor quas.",
            "severity": "medium",
            "color": "#E58A1F",
            "position": 1,
            "notify_emails": [],
            "slack_channels": [],
            "slack_aliases": [],
            "created_at": "2026-01-21T18:29:06.166-08:00",
            "updated_at": "2026-01-21T18:29:06.166-08:00"
          }
        }
      },
      "in_triage_by": null,
      "started_by": {
        "data": {
          "id": "619",
          "type": "users",
          "attributes": {
            "name": "Otha Hyatt",
            "email": "[email protected]",
            "phone": null,
            "phone_2": null,
            "first_name": "Otha",
            "last_name": "Hyatt",
            "full_name": "Otha Hyatt",
            "full_name_with_team": "[Mraz and Sons] Otha Hyatt",
            "slack_id": null,
            "time_zone": "Etc/UTC",
            "updated_at": "2026-01-21T18:29:06.192-08:00",
            "created_at": "2026-01-21T18:29:05.126-08:00"
          },
          "relationships": {
            "email_addresses": {
              "data": [
                {
                  "id": "9e41ce9a-3942-4e1a-a64a-d5ac89553f85",
                  "type": "user_email_addresses"
                }
              ]
            },
            "phone_numbers": {
              "data": []
            },
            "devices": {
              "data": []
            },
            "role": {
              "data": {
                "id": "3d5b2a7b-0842-494a-8f63-c748858babe2",
                "alerts_permissions": [
                  "create",
                  "read"
                ],
                "api_keys_permissions": [
                  "create",
                  "update",
                  "read",
                  "delete"
                ],
                "audits_permissions": [],
                "billing_permissions": [],
                "catalogs_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "communication_permissions": [
                  "read"
                ],
                "created_at": "2026-01-21T18:29:04.434-08:00",
                "deleted_at": null,
                "display_order": 2,
                "edge_connector_permissions": [],
                "environments_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "form_fields_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "functionalities_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "groups_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_causes_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_communication_permissions": [
                  "read"
                ],
                "incident_feedbacks_permissions": [
                  "read",
                  "create",
                  "update"
                ],
                "incident_permission_set_id": "27e4595e-fe60-485d-8a4c-d9b8ee7fb2d2",
                "incident_roles_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_types_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incidents_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "integrations_permissions": [],
                "invitations_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "is_deletable": false,
                "is_editable": true,
                "name": "user",
                "paging_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "playbooks_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "private_incidents_permissions": [],
                "pulses_permissions": [
                  "create",
                  "update",
                  "read"
                ],
                "retrospective_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "roles_permissions": [],
                "secrets_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "services_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "severities_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "slug": "user",
                "status_pages_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "sub_statuses_permissions": [
                  "read"
                ],
                "team_id": 383,
                "updated_at": "2026-01-21T18:29:04.434-08:00",
                "webhooks_permissions": [],
                "workflows_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ]
              }
            },
            "on_call_role": {
              "data": {
                "id": "69482b9d-42ee-42fb-aaf7-e5b0b01fa857",
                "alert_fields_permissions": [],
                "alert_groups_permissions": [],
                "alert_routing_rules_permissions": [],
                "alert_sources_permissions": [],
                "alert_urgency_permissions": [],
                "alerts_permissions": [],
                "api_keys_permissions": [],
                "audits_permissions": [],
                "contacts_permissions": [],
                "created_at": "2026-01-21T18:29:04.460-08:00",
                "deleted_at": null,
                "escalation_policies_permissions": [],
                "groups_permissions": [],
                "heartbeats_permissions": [],
                "integrations_permissions": [],
                "invitations_permissions": [],
                "live_call_routing_permissions": [],
                "name": "None",
                "on_call_readiness_report_permissions": [],
                "on_call_roles_permissions": [],
                "schedule_override_permissions": [],
                "schedules_permissions": [],
                "services_permissions": [],
                "shift_overrides_permissions": [],
                "slug": "none",
                "system_role": "no_access",
                "team_id": 383,
                "updated_at": "2026-01-21T18:29:04.460-08:00",
                "webhooks_permissions": [],
                "workflows_permissions": []
              }
            },
            "teams": {
              "data": []
            },
            "schedules": {
              "data": []
            },
            "notification_rules": {
              "data": [
                {
                  "id": "86203c88-4864-460b-83c8-d2cf815991b6",
                  "type": "user_notification_rules"
                },
                {
                  "id": "e08151cf-bd66-469d-9a3d-b5f00e993803",
                  "type": "user_notification_rules"
                }
              ]
            }
          }
        }
      },
      "mitigated_by": null,
      "resolved_by": null,
      "closed_by": null,
      "cancelled_by": {
        "data": {
          "id": "617",
          "type": "users",
          "attributes": {
            "name": "Thao Kessler",
            "email": "[email protected]",
            "phone": null,
            "phone_2": null,
            "first_name": "Thao",
            "last_name": "Kessler",
            "full_name": "Thao Kessler",
            "full_name_with_team": "[Mraz and Sons] Thao Kessler",
            "slack_id": null,
            "time_zone": "Etc/UTC",
            "updated_at": "2026-01-21T18:29:31.426-08:00",
            "created_at": "2026-01-21T18:29:04.136-08:00"
          },
          "relationships": {
            "email_addresses": {
              "data": [
                {
                  "id": "98e8d498-9214-49c2-89d6-083a1ef37a77",
                  "type": "user_email_addresses"
                }
              ]
            },
            "phone_numbers": {
              "data": []
            },
            "devices": {
              "data": []
            },
            "role": {
              "data": {
                "id": "3d5b2a7b-0842-494a-8f63-c748858babe2",
                "alerts_permissions": [
                  "create",
                  "read"
                ],
                "api_keys_permissions": [
                  "create",
                  "update",
                  "read",
                  "delete"
                ],
                "audits_permissions": [],
                "billing_permissions": [],
                "catalogs_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "communication_permissions": [
                  "read"
                ],
                "created_at": "2026-01-21T18:29:04.434-08:00",
                "deleted_at": null,
                "display_order": 2,
                "edge_connector_permissions": [],
                "environments_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "form_fields_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "functionalities_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "groups_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_causes_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_communication_permissions": [
                  "read"
                ],
                "incident_feedbacks_permissions": [
                  "read",
                  "create",
                  "update"
                ],
                "incident_permission_set_id": "27e4595e-fe60-485d-8a4c-d9b8ee7fb2d2",
                "incident_roles_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_types_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incidents_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "integrations_permissions": [],
                "invitations_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "is_deletable": false,
                "is_editable": true,
                "name": "user",
                "paging_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "playbooks_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "private_incidents_permissions": [],
                "pulses_permissions": [
                  "create",
                  "update",
                  "read"
                ],
                "retrospective_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "roles_permissions": [],
                "secrets_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "services_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "severities_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "slug": "user",
                "status_pages_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "sub_statuses_permissions": [
                  "read"
                ],
                "team_id": 383,
                "updated_at": "2026-01-21T18:29:04.434-08:00",
                "webhooks_permissions": [],
                "workflows_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ]
              }
            },
            "on_call_role": {
              "data": {
                "id": "69482b9d-42ee-42fb-aaf7-e5b0b01fa857",
                "alert_fields_permissions": [],
                "alert_groups_permissions": [],
                "alert_routing_rules_permissions": [],
                "alert_sources_permissions": [],
                "alert_urgency_permissions": [],
                "alerts_permissions": [],
                "api_keys_permissions": [],
                "audits_permissions": [],
                "contacts_permissions": [],
                "created_at": "2026-01-21T18:29:04.460-08:00",
                "deleted_at": null,
                "escalation_policies_permissions": [],
                "groups_permissions": [],
                "heartbeats_permissions": [],
                "integrations_permissions": [],
                "invitations_permissions": [],
                "live_call_routing_permissions": [],
                "name": "None",
                "on_call_readiness_report_permissions": [],
                "on_call_roles_permissions": [],
                "schedule_override_permissions": [],
                "schedules_permissions": [],
                "services_permissions": [],
                "shift_overrides_permissions": [],
                "slug": "none",
                "system_role": "no_access",
                "team_id": 383,
                "updated_at": "2026-01-21T18:29:04.460-08:00",
                "webhooks_permissions": [],
                "workflows_permissions": []
              }
            },
            "teams": {
              "data": []
            },
            "schedules": {
              "data": []
            },
            "notification_rules": {
              "data": [
                {
                  "id": "5207901c-f98c-40f1-8265-9f9bdc013449",
                  "type": "user_notification_rules"
                },
                {
                  "id": "516aee43-70c3-43fc-bc62-0cc3a68db464",
                  "type": "user_notification_rules"
                }
              ]
            }
          }
        }
      },
      "mitigation_message": null,
      "resolution_message": null,
      "cancellation_message": "Nevermind!",
      "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": "2026-01-21T18:29:06.172-08:00",
      "detected_at": null,
      "acknowledged_at": null,
      "mitigated_at": null,
      "resolved_at": null,
      "closed_at": null,
      "cancelled_at": "2026-01-21T18:29:31.618-08:00",
      "created_at": "2026-01-21T18:29:06.172-08:00",
      "updated_at": "2026-01-21T18:29:31.674-08:00",
      "muted_service_ids": [],
      "labels": {}
    },
    "relationships": {
      "incident_post_mortem": {
        "data": {
          "id": "0b0c37a7-9e6f-41fe-9959-cb67e8873d58",
          "type": "incident_post_mortems"
        }
      },
      "causes": {
        "data": []
      },
      "subscribers": {
        "data": []
      },
      "roles": {
        "data": []
      },
      "environments": {
        "data": []
      },
      "incident_types": {
        "data": []
      },
      "services": {
        "data": []
      },
      "functionalities": {
        "data": []
      },
      "groups": {
        "data": []
      },
      "events": {
        "data": [
          {
            "id": "642e49e6-38de-405b-9dda-48fc48c80c04",
            "type": "incident_events"
          },
          {
            "id": "7c2e5905-66ea-476b-8907-95cdf3253f8f",
            "type": "incident_events"
          },
          {
            "id": "9020899f-b61f-4e4a-88eb-57e370d639b2",
            "type": "incident_events"
          }
        ]
      },
      "action_items": {
        "data": []
      },
      "custom_field_selections": {
        "data": []
      },
      "feedbacks": {
        "data": []
      },
      "attachments": {
        "data": []
      },
      "slack_messages": {
        "data": []
      },
      "alerts": {
        "data": []
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
required

Resource UUID

Body

application/vnd.api+json
data
object
required

Response

incident cancel

data
object
required