PUT
/
v1
/
incidents
/
{id}
/
cancel
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": "a29f0733-c07d-42f9-8050-be42bce9b981",
    "type": "incidents",
    "attributes": {
      "parent_incident_id": null,
      "sequential_id": 1,
      "title": "Maiores ullam perferendis sint.",
      "slug": "maiores-ullam-perferendis-sint",
      "kind": "normal",
      "private": false,
      "summary": "Voluptatem nesciunt sit. Architecto repellat ut. Enim sed amet.",
      "status": "cancelled",
      "source": "web",
      "url": "http://localhost:3001/account/incidents/1-maiores-ullam-perferendis-sint",
      "short_url": null,
      "user": {
        "data": {
          "id": "301",
          "type": "users",
          "attributes": {
            "name": "Miles Hyatt",
            "email": "norberto@hudson-mcclure.example",
            "phone": null,
            "phone_2": null,
            "first_name": "Miles",
            "last_name": "Hyatt",
            "full_name": "Miles Hyatt",
            "full_name_with_team": "[Boyer LLC] Miles Hyatt",
            "slack_id": null,
            "time_zone": "UTC",
            "updated_at": "2025-06-20T12:01:31.398-07:00",
            "created_at": "2025-06-20T12:01:31.049-07:00"
          },
          "relationships": {
            "email_addresses": {
              "data": [
                {
                  "id": "9bf6d458-b8ee-423b-a03d-41fa44912122",
                  "type": "user_email_addresses"
                }
              ]
            },
            "phone_numbers": {
              "data": []
            },
            "devices": {
              "data": []
            },
            "role": {
              "data": {
                "id": "4f1c1422-fc57-48f6-bbab-312bb8520472",
                "created_at": "2025-06-20T12:01:30.446-07:00",
                "updated_at": "2025-06-20T12:01:30.446-07:00",
                "display_order": 2,
                "api_keys_permissions": [
                  "create",
                  "update",
                  "read",
                  "delete"
                ],
                "billing_permissions": [],
                "environments_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_roles_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_types_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incidents_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "private_incidents_permissions": [],
                "invitations_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "playbooks_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "retrospective_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "roles_permissions": [],
                "services_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "severities_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "status_pages_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "workflows_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "team_id": 273,
                "name": "user",
                "slug": "user",
                "is_editable": true,
                "is_deletable": false,
                "incident_feedbacks_permissions": [
                  "read",
                  "create",
                  "update"
                ],
                "form_fields_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "webhooks_permissions": [],
                "audits_permissions": [],
                "secrets_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "deleted_at": null,
                "incident_permission_set_id": "af823bbe-d501-4a80-9541-e119d56735a7",
                "pulses_permissions": [
                  "create",
                  "update",
                  "read"
                ],
                "alerts_permissions": [
                  "create",
                  "read"
                ],
                "paging_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "sub_statuses_permissions": [
                  "read"
                ],
                "catalogs_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "communication_permissions": [
                  "read"
                ],
                "incident_communication_permissions": [
                  "read"
                ],
                "integrations_permissions": []
              }
            },
            "on_call_role": {
              "data": {
                "id": "bd2a28b0-e8ea-4314-8223-01c445688729",
                "team_id": 273,
                "name": "None",
                "slug": "none",
                "system_role": "no_access",
                "deleted_at": null,
                "created_at": "2025-06-20T12:01:30.464-07:00",
                "updated_at": "2025-06-20T12:01:30.464-07:00",
                "alerts_permissions": [],
                "api_keys_permissions": [],
                "audits_permissions": [],
                "escalation_policies_permissions": [],
                "groups_permissions": [],
                "integrations_permissions": [],
                "invitations_permissions": [],
                "on_call_roles_permissions": [],
                "schedules_permissions": [],
                "services_permissions": [],
                "shift_overrides_permissions": [],
                "workflows_permissions": [],
                "contacts_permissions": [],
                "live_call_routing_permissions": [],
                "heartbeats_permissions": [],
                "alert_urgency_permissions": [],
                "schedule_override_permissions": [],
                "webhooks_permissions": [],
                "alert_sources_permissions": [],
                "on_call_readiness_report_permissions": [],
                "alert_routing_rules_permissions": [],
                "alert_fields_permissions": [],
                "alert_groups_permissions": []
              }
            }
          }
        }
      },
      "severity": {
        "data": {
          "id": "7b6b8086-3b5f-4d0c-8db3-52f9e9112c38",
          "type": "severities",
          "attributes": {
            "name": "ud7ck",
            "slug": "ud7ck",
            "description": "Reprehenderit dolorem natus ducimus.",
            "severity": "medium",
            "color": "#E58A1F",
            "position": 1,
            "notify_emails": [],
            "slack_channels": [],
            "slack_aliases": [],
            "created_at": "2025-06-20T12:01:31.363-07:00",
            "updated_at": "2025-06-20T12:01:31.363-07:00"
          }
        }
      },
      "in_triage_by": null,
      "started_by": {
        "data": {
          "id": "301",
          "type": "users",
          "attributes": {
            "name": "Miles Hyatt",
            "email": "norberto@hudson-mcclure.example",
            "phone": null,
            "phone_2": null,
            "first_name": "Miles",
            "last_name": "Hyatt",
            "full_name": "Miles Hyatt",
            "full_name_with_team": "[Boyer LLC] Miles Hyatt",
            "slack_id": null,
            "time_zone": "UTC",
            "updated_at": "2025-06-20T12:01:31.398-07:00",
            "created_at": "2025-06-20T12:01:31.049-07:00"
          },
          "relationships": {
            "email_addresses": {
              "data": [
                {
                  "id": "9bf6d458-b8ee-423b-a03d-41fa44912122",
                  "type": "user_email_addresses"
                }
              ]
            },
            "phone_numbers": {
              "data": []
            },
            "devices": {
              "data": []
            },
            "role": {
              "data": {
                "id": "4f1c1422-fc57-48f6-bbab-312bb8520472",
                "created_at": "2025-06-20T12:01:30.446-07:00",
                "updated_at": "2025-06-20T12:01:30.446-07:00",
                "display_order": 2,
                "api_keys_permissions": [
                  "create",
                  "update",
                  "read",
                  "delete"
                ],
                "billing_permissions": [],
                "environments_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_roles_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_types_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incidents_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "private_incidents_permissions": [],
                "invitations_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "playbooks_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "retrospective_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "roles_permissions": [],
                "services_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "severities_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "status_pages_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "workflows_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "team_id": 273,
                "name": "user",
                "slug": "user",
                "is_editable": true,
                "is_deletable": false,
                "incident_feedbacks_permissions": [
                  "read",
                  "create",
                  "update"
                ],
                "form_fields_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "webhooks_permissions": [],
                "audits_permissions": [],
                "secrets_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "deleted_at": null,
                "incident_permission_set_id": "af823bbe-d501-4a80-9541-e119d56735a7",
                "pulses_permissions": [
                  "create",
                  "update",
                  "read"
                ],
                "alerts_permissions": [
                  "create",
                  "read"
                ],
                "paging_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "sub_statuses_permissions": [
                  "read"
                ],
                "catalogs_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "communication_permissions": [
                  "read"
                ],
                "incident_communication_permissions": [
                  "read"
                ],
                "integrations_permissions": []
              }
            },
            "on_call_role": {
              "data": {
                "id": "bd2a28b0-e8ea-4314-8223-01c445688729",
                "team_id": 273,
                "name": "None",
                "slug": "none",
                "system_role": "no_access",
                "deleted_at": null,
                "created_at": "2025-06-20T12:01:30.464-07:00",
                "updated_at": "2025-06-20T12:01:30.464-07:00",
                "alerts_permissions": [],
                "api_keys_permissions": [],
                "audits_permissions": [],
                "escalation_policies_permissions": [],
                "groups_permissions": [],
                "integrations_permissions": [],
                "invitations_permissions": [],
                "on_call_roles_permissions": [],
                "schedules_permissions": [],
                "services_permissions": [],
                "shift_overrides_permissions": [],
                "workflows_permissions": [],
                "contacts_permissions": [],
                "live_call_routing_permissions": [],
                "heartbeats_permissions": [],
                "alert_urgency_permissions": [],
                "schedule_override_permissions": [],
                "webhooks_permissions": [],
                "alert_sources_permissions": [],
                "on_call_readiness_report_permissions": [],
                "alert_routing_rules_permissions": [],
                "alert_fields_permissions": [],
                "alert_groups_permissions": []
              }
            }
          }
        }
      },
      "mitigated_by": null,
      "resolved_by": null,
      "closed_by": null,
      "cancelled_by": {
        "data": {
          "id": "299",
          "type": "users",
          "attributes": {
            "name": "Ilona Wolff",
            "email": "reid.heaney@dibbert.test",
            "phone": null,
            "phone_2": null,
            "first_name": "Ilona",
            "last_name": "Wolff",
            "full_name": "Ilona Wolff",
            "full_name_with_team": "[Boyer LLC] Ilona Wolff",
            "slack_id": null,
            "time_zone": "UTC",
            "updated_at": "2025-06-20T12:01:52.646-07:00",
            "created_at": "2025-06-20T12:01:30.311-07:00"
          },
          "relationships": {
            "email_addresses": {
              "data": [
                {
                  "id": "3e253f54-c3ae-48bd-b950-a75dcd7baa90",
                  "type": "user_email_addresses"
                }
              ]
            },
            "phone_numbers": {
              "data": []
            },
            "devices": {
              "data": []
            },
            "role": {
              "data": {
                "id": "4f1c1422-fc57-48f6-bbab-312bb8520472",
                "created_at": "2025-06-20T12:01:30.446-07:00",
                "updated_at": "2025-06-20T12:01:30.446-07:00",
                "display_order": 2,
                "api_keys_permissions": [
                  "create",
                  "update",
                  "read",
                  "delete"
                ],
                "billing_permissions": [],
                "environments_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_roles_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incident_types_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "incidents_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "private_incidents_permissions": [],
                "invitations_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "playbooks_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "retrospective_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "roles_permissions": [],
                "services_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "severities_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "status_pages_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "workflows_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "team_id": 273,
                "name": "user",
                "slug": "user",
                "is_editable": true,
                "is_deletable": false,
                "incident_feedbacks_permissions": [
                  "read",
                  "create",
                  "update"
                ],
                "form_fields_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "webhooks_permissions": [],
                "audits_permissions": [],
                "secrets_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "deleted_at": null,
                "incident_permission_set_id": "af823bbe-d501-4a80-9541-e119d56735a7",
                "pulses_permissions": [
                  "create",
                  "update",
                  "read"
                ],
                "alerts_permissions": [
                  "create",
                  "read"
                ],
                "paging_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "sub_statuses_permissions": [
                  "read"
                ],
                "catalogs_permissions": [
                  "create",
                  "read",
                  "update",
                  "delete"
                ],
                "communication_permissions": [
                  "read"
                ],
                "incident_communication_permissions": [
                  "read"
                ],
                "integrations_permissions": []
              }
            },
            "on_call_role": {
              "data": {
                "id": "bd2a28b0-e8ea-4314-8223-01c445688729",
                "team_id": 273,
                "name": "None",
                "slug": "none",
                "system_role": "no_access",
                "deleted_at": null,
                "created_at": "2025-06-20T12:01:30.464-07:00",
                "updated_at": "2025-06-20T12:01:30.464-07:00",
                "alerts_permissions": [],
                "api_keys_permissions": [],
                "audits_permissions": [],
                "escalation_policies_permissions": [],
                "groups_permissions": [],
                "integrations_permissions": [],
                "invitations_permissions": [],
                "on_call_roles_permissions": [],
                "schedules_permissions": [],
                "services_permissions": [],
                "shift_overrides_permissions": [],
                "workflows_permissions": [],
                "contacts_permissions": [],
                "live_call_routing_permissions": [],
                "heartbeats_permissions": [],
                "alert_urgency_permissions": [],
                "schedule_override_permissions": [],
                "webhooks_permissions": [],
                "alert_sources_permissions": [],
                "on_call_readiness_report_permissions": [],
                "alert_routing_rules_permissions": [],
                "alert_fields_permissions": [],
                "alert_groups_permissions": []
              }
            }
          }
        }
      },
      "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": "2025-06-20T12:01:31.369-07:00",
      "detected_at": null,
      "acknowledged_at": null,
      "mitigated_at": null,
      "resolved_at": null,
      "closed_at": null,
      "cancelled_at": "2025-06-20T12:01:52.792-07:00",
      "created_at": "2025-06-20T12:01:31.369-07:00",
      "updated_at": "2025-06-20T12:01:52.853-07:00",
      "labels": {}
    },
    "relationships": {
      "incident_post_mortem": {
        "data": {
          "id": "8dcee42a-93f5-44ce-a824-04ebda2f300e",
          "type": "incident_post_mortems"
        }
      },
      "causes": {
        "data": []
      },
      "subscribers": {
        "data": []
      },
      "roles": {
        "data": []
      },
      "environments": {
        "data": []
      },
      "incident_types": {
        "data": []
      },
      "services": {
        "data": []
      },
      "functionalities": {
        "data": []
      },
      "groups": {
        "data": []
      },
      "events": {
        "data": [
          {
            "id": "48af5612-26b0-4684-b25d-8992b50676a3",
            "type": "incident_events"
          },
          {
            "id": "5915c21c-e285-4036-9e6c-1a788c9b804a",
            "type": "incident_events"
          },
          {
            "id": "4a58e062-a6af-4f3b-9af7-bb9ec5f768fd",
            "type": "incident_events"
          }
        ]
      },
      "action_items": {
        "data": []
      },
      "custom_field_selections": {
        "data": []
      },
      "feedbacks": {
        "data": []
      },
      "attachments": {
        "data": []
      },
      "slack_messages": {
        "data": []
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Body

application/vnd.api+json

Response

200
application/vnd.api+json

incident cancel

The response is of type object.