incident.io integration: operations for AI agents
incident.io connects to Type.com as an integration. This page lists the 340 operations documented for Claude and Codex in Type.com: 154 read, 96 write, 90 destructive.
About incident.io
incident.io vendor API references, subject to vendor permissions and account availability.
Categories: Developer Tools & IT
How to connect incident.io to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
340 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
340 operations listed.
- Read
List Actions V1
List all actions for an organisation.
GET /v1/actions - Read
Show Actions V1
Get a single incident action.
GET /v1/actions/{id} - Read
List Alert Notes V1
List alert notes attached to an alert.
GET /v1/alert_notes - Read
Show Alert Notes V1
Get a single alert note.
GET /v1/alert_notes/{id} - Read
List API Keys V1
List API keys visible to the calling API key, with pagination. An API key with account-level `api_keys_manage` access will see all keys, while a key with the `api_keys_manage` role scoped to specific teams will only see keys belonging to those teams. This endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.
GET /v1/api_keys - Read
Show API Keys V1
Show details of a specific API key, including its roles, team assignments and when its token was last issued. This endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.
GET /v1/api_keys/{id} - Read
List Custom Field Options V1
Show custom field options for a custom field
GET /v1/custom_field_options - Read
Show Custom Field Options V1
Get a single custom field option
GET /v1/custom_field_options/{id} - Read
List Custom Fields V1
List all custom fields for an organisation.
GET /v1/custom_fields - Read
Show Custom Fields V1
Get a single custom field.
GET /v1/custom_fields/{id} - Read
Identity Utilities V1
Test if your API key is valid, and which roles it has.
GET /v1/identity - Read
List Incident Attachments V1
List all incident attachments for a given external resource or incident. You must provide either a specific incident ID or a specific external resource type and external ID.
GET /v1/incident_attachments - Read
List Incident Relationships V1
List related incidents for a specific incident.
GET /v1/incident_relationships - Read
List Incident Roles V1
List all incident roles for an organisation.
GET /v1/incident_roles - Read
Show Incident Roles V1
Get a single incident role.
GET /v1/incident_roles/{id} - Read
List Incident Statuses V1
List all incident statuses for an organisation.
GET /v1/incident_statuses - Read
Show Incident Statuses V1
Get a single incident status.
GET /v1/incident_statuses/{id} - Read
List Incident Templates V1
List all incident templates for this organisation.
GET /v1/incident_templates - Read
Validate Incident Templates V1
Check whether an incident template's config is valid, without creating or updating anything. This validates in the same way a create or update would: expressions are compiled and checked against your catalog. An invalid config is an error. A config that is valid but probably not what you meant — such as a name that's already taken — comes back as a warning on a successful response, so a client can show it without blocking.
POST /v1/incident_templates/actions/validate - Read
Show Incident Templates V1
Show a single incident template.
GET /v1/incident_templates/{id} - Read
List Incident Types V1
List all incident types for an organisation.
GET /v1/incident_types - Read
Show Incident Types V1
Get a single incident type.
GET /v1/incident_types/{id} - Read
List Incidents V1
List all incidents for an organisation.
GET /v1/incidents - Read
Show Incidents V1
Get a single incident.
GET /v1/incidents/{id} - Read
ShowIPAllowlist IPAllowlists V1
Show the IP allowlist for your organisation
GET /v1/ip_allowlists - Read
IPRanges Utilities V1
List the IP addresses our requests to your systems come from. Use this to keep a firewall allowlist up to date without watching our documentation. Poll it rather than copying the list once. We give at least two weeks' notice before our own addresses change. Webhook deliveries come from our provider's addresses, so we cannot promise notice on those. These are the addresses we send from. Do not allowlist them for inbound access: our API is served on different addresses, and those change without notice.
GET /v1/ip_ranges - Read
List MaintenanceWindows V1
List maintenance windows for your organisation.
GET /v1/maintenance_windows - Read
Show MaintenanceWindows V1
Show a particular maintenance window.
GET /v1/maintenance_windows/{id} - Read
OpenAPIV3 Utilities V1
Get the OpenAPI (v3) definition.
GET /v1/openapiV3.json - Read
List PostmortemDocuments V1
List post-mortem documents for the organisation. Results can be filtered by incident and sorted by creation date. This endpoint returns document metadata only. If you want to fetch the content of the post-mortem, use the ShowContent endpoint.
GET /v1/postmortem_documents - Read
Show PostmortemDocuments V1
Get a single post-mortem document by ID. This returns the document's metadata. To retrieve the content of the post-mortem, use the ShowContent endpoint.
GET /v1/postmortem_documents/{id} - Read
ShowContent PostmortemDocuments V1
Fetch the content of a post-mortem document, rendered as markdown. The response contains the full document content as a single markdown string. The markdown follows standard formatting and is structured to mirror the post-mortem as it appears in the incident.io dashboard: - **Headings** (`#`, `##`, `###`) for document title and sections - **Bold** and *italic* text formatting - Bullet lists and numbered lists - [Links](url) to external resources, Slack threads, and pull requests - Mentions of users, incidents, and catalog entries resolved to their display names - Custom field values rendered as labelled bullet lists - Timeline entries grouped by date with timestamps - Follow-ups with assignees and descriptions To preview what this markdown will look like for a given post-mortem, open the document in the incident.io dashboard and use the "Copy to clipboard" button. The copied content uses the same rendering pipeline as this endpoint. If you only need document metadata, use the Show or List endpoints instead.
GET /v1/postmortem_documents/{id}/content - Read
List Severities V1
List all incident severities for an organisation.
GET /v1/severities - Read
Show Severities V1
Get a single incident severity.
GET /v1/severities/{id} - Read
ListResponseIncidents Status Pages V1
List the linked Response incidents for a status page incident.
GET /v1/status-pages/{id}/incidents/{incident_id}/response-incidents - Read
List Actions V2
Deprecated: this endpoint will be removed on 31 December 2026. Use <code>GET /v3/actions</code> instead. List all actions for an organisation.
GET /v2/actions - Read
Show Actions V2
Deprecated: this endpoint will be removed on 31 December 2026. Use <code>GET /v3/actions/{id}</code> instead. Get a single incident action.
GET /v2/actions/{id} - Read
List Alert Attachments V2
List the attachments on an alert or alert group, newest first. Provide exactly one of alert_id or alert_group_id. Listing by alert_id returns only what is attached to that alert, not what is attached to its alert group.
GET /v2/alert_attachments - Read
List Alert Attributes V2
List alert attributes.
GET /v2/alert_attributes - Read
Show Alert Attributes V2
Show an alert attribute.
GET /v2/alert_attributes/{id} - Read
List Alert Routes V2
List all alert routes in your account.
GET /v2/alert_routes - Read
Show Alert Routes V2
Load details about a specific alert route in your account.
GET /v2/alert_routes/{id} - Read
List Alert Sources V2
List all alert sources in your account.
GET /v2/alert_sources - Read
Validate Alert Sources V2
Check whether an alert source template is valid, without creating or updating anything. This validates the template in the same way a create or update would: expressions are compiled and checked against your alert schema and catalog, and merge strategies are checked against the attributes they bind to. Values that are only known once an alert source exists are not validated.
POST /v2/alert_sources/actions/validate - Read
Show Alert Sources V2
Load details about a specific alert source in your account.
GET /v2/alert_sources/{id} - Read
ListAlertTags Alerts V2
List the alert tags in your organisation's vocabulary. Alert tags are the reusable labels you can apply to alerts. This endpoint lists the organisation's active tags, ordered by name, and excludes archived tags. To narrow the list, filter by search, which matches tags whose name contains the given value (case-insensitive): curl --get 'https://api.incident.io/v2/alert_tags' \ --data 'search=noisy'
GET /v2/alert_tags - Read
List Alerts V2
List all alerts for your account. This endpoint supports a number of filters, which can help find alerts matching certain criteria. These filters work similarly to the filters on the incidents endpoint, where a field is specified alongside a comparison operator in the query string. Note that: - Filters may be used together, and the result will be alerts that match all filters. - All query parameters must be URI encoded. ### By deduplication_key Find all alerts with deduplication_key ABC: curl --get 'https://api.incident.io/v2/alerts' \ --data 'deduplication_key[is]=ABC' ### By status Find all alerts in a firing state: curl --get 'https://api.incident.io/v2/alerts' \ --data 'status[one_of]=firing' ### By alert_source Find all alerts from a specific alert source (by alert source ID): curl --get 'https://api.incident.io/v2/alerts' \ --data 'alert_source[one_of]=01GBSQF3FHF7FWZQNWGHAVQ804' Find all alerts not from a specific alert source: curl --get 'https://api.incident.io/v2/alerts' \ --data 'alert_source[not_in]=01GBSQF3FHF7FWZQNWGHAVQ804' ### By alert_group_id Find all alerts in a specific alert group: curl --get 'https://api.incident.io/v2/alerts' \ --data 'alert_group_id[one_of]=01GBSQF3FHF7FWZQNWGHAVQ804' ### By created_at Find all alerts that follow specified date parameters for created_at field. Possible values are "gte" (greater than or equal to), "lte" (less than or equal to), and "date_range" (between two dates). The following example finds all alerts created after 2025-01-01: curl --get 'https://api.incident.io/v2/alerts' \ --data 'created_at[gte]=2025-01-01' To find alerts created within a specific date range, use the date_range option with tilde-separated dates: curl --get 'https://api.incident.io/v2/alerts' \ --data 'created_at[date_range]=2024-12-02~2024-12-08' ### By updated_at Find all alerts that follow specified date parameters for updated_at field, using the same "gte", "lte" and "date_range" operators as created_at. This is useful for incrementally syncing alerts: poll with updated_at[gte] set to your last sync time instead of re-fetching the full history. Note that updated_at moves whenever the alert row is written, which can happen without a visible change to the alert payload, so treat matches as candidates to re-fetch rather than guaranteed changes — and overlap your sync window by a few minutes to allow for writes that commit out of timestamp order: curl --get 'https://api.incident.io/v2/alerts' \ --data 'updated_at[gte]=2025-01-01T00:00:00Z' ### By has_notes Find all alerts that have notes attached: curl --get 'https://api.incident.io/v2/alerts' \ --data 'has_notes[is]=true' Find all alerts that have no notes attached: curl --get 'https://api.incident.io/v2/alerts' \ --data 'has_notes[is]=false' ### By tags Filter by tag name, matched case-insensitively. Find all alerts that have any of the given tags: curl --get 'https://api.incident.io/v2/alerts' \ --data 'tags[one_of]=known issue' Find all alerts that have all of the given tags: curl --get 'https://api.incident.io/v2/alerts' \ --data 'tags[all_of]=known issue' \ --data 'tags[all_of]=customer impacting' Find all alerts that do not have any of the given tags. Untagged alerts are included: curl --get 'https://api.incident.io/v2/alerts' \ --data 'tags[not_in]=known issue' ### By attributes Alerts can be filtered by their attribute values. Each filter is keyed by the alert attribute ID, followed by an operator and the values to match. The accepted operators depend on the attribute's type. Find all alerts where attribute 01GBSQF3FHF7FWZQNWGHAVQ804 is one of two catalog entries: curl --get 'https://api.incident.io/v2/alerts' \ --data 'attributes[01GBSQF3FHF7FWZQNWGHAVQ804][one_of]=01GBSQF3FHF7FWZQNWGHAVQ804' \ --data 'attributes[01GBSQF3FHF7FWZQNWGHAVQ804][one_of]=01ET65M7ZARSFZ6TFDFVQDN9AA' You can filter on multiple attributes at once, and the result will be alerts that match all of them. ### Maintenance windows By default, all alerts are returned including those held by a maintenance window. To exclude alerts that are held by a maintenance window: curl --get 'https://api.incident.io/v2/alerts' \ --data 'include_maintenance_window[is]=false'
GET /v2/alerts - Read
Show Alerts V2
Show a single alert for your account
GET /v2/alerts/{id} - Read
List Announcement Rules V2
List announcement rules for this organisation.
GET /v2/announcement_rules - Read
Show Announcement Rules V2
Show an announcement rule.
GET /v2/announcement_rules/{id} - Read
List Announcement Templates V2
List announcement templates for this organisation.
GET /v2/announcement_templates - Read
Show Announcement Templates V2
Show an announcement template.
GET /v2/announcement_templates/{id} - Read
List Call Routes V2
List all call routes for this organisation.
GET /v2/call_routes - Read
ListAllowedCallers Call Routes V2
List the numbers allowed to call a route.
GET /v2/call_routes/{call_route_id}/allowed_callers - Read
ShowAllowedCaller Call Routes V2
Show a single allowed caller.
GET /v2/call_routes/{call_route_id}/allowed_callers/{id} - Read
ListOptions Call Routes V2
List a call route's phone-tree options, in the order callers hear them.
GET /v2/call_routes/{call_route_id}/options - Read
ShowOption Call Routes V2
Show a single phone-tree option.
GET /v2/call_routes/{call_route_id}/options/{id} - Read
Show Call Routes V2
Show a single call route.
GET /v2/call_routes/{id} - Read
List Call Sessions V2
List Scribe call sessions, newest first, filtered by incident.
GET /v2/call_sessions - Read
List Call Transcript Entries V2
List transcript entries for a call session, oldest first. Returns an empty list if your organisation has disabled viewing transcripts.
GET /v2/call_transcript_entries - Read
ListEntries Catalog V2
List entries for a catalog type.
GET /v2/catalog_entries - Read
ShowEntry Catalog V2
Show a single catalog entry.
GET /v2/catalog_entries/{id} - Read
ListResources Catalog V2
List available engine resources for the catalog. A resource represents a type of data that can be held within the catalog, so this endpoint can be used to see what attribute types can be used when updating the schema of a catalog type.
GET /v2/catalog_resources - Read
ListTypes Catalog V2
List all catalog types for an organisation, including those synced from external resources.
GET /v2/catalog_types - Read
ShowType Catalog V2
Show a single catalog type.
GET /v2/catalog_types/{id} - Read
List Custom Fields V2
List all custom fields for an organisation.
GET /v2/custom_fields - Read
Show Custom Fields V2
Get a single custom field.
GET /v2/custom_fields/{id} - Read
List Escalation Path Templates V2
List active escalation path templates.
GET /v2/escalation_path_templates - Read
Show Escalation Path Templates V2
Show a particular escalation path template.
GET /v2/escalation_path_templates/{id} - Read
ListPaths Escalations V2
List all escalation paths in your account. An escalation path is a series of steps that describe how a page should be escalated, represented as a graph, supporting conditional branches based on alert priority and working intervals.
GET /v2/escalation_paths - Read
ShowPath Escalations V2
Show an escalation path. We recommend you create escalation paths in the incident.io dashboard where our path builder makes it easy to use conditions and visualise the path.
GET /v2/escalation_paths/{id} - Read
List Escalations V2
List all escalations for your account. This endpoint supports a number of filters, which can help find escalations matching certain criteria. Note that: - Filters may be used together, and the result will be escalations that match all filters. - All query parameters must be URI encoded. To use this API, you will need an API key with the "View data" or "Create and manage on-call resources" permission. ### By escalation_path Find all escalations that escalated to escalation path with id=ABC: curl --get 'https://api.incident.io/v2/escalations' \ --data 'escalation_path[one_of]=ABC' ### By status Find all escalations with a current status of "triggered": curl --get 'https://api.incident.io/v2/escalations' \ --data 'status[one_of]=triggered' Possible values are "pending", "triggered", "acked", "resolved", "expired" and "cancelled". Escalations are in "pending" when they are in a grace period when the related alert has been grouped in an incident. ### By alert Find all escalations that were created by alert with id=ABC: curl --get 'https://api.incident.io/v2/escalations' \ --data 'alert[one_of]=ABC' ### By incident Find all escalations related to incident with id=ABC: curl --get 'https://api.incident.io/v2/escalations' \ --data 'incident[one_of]=ABC' An escalation is related to an incident if it is linked to that incident directly, if it is attached to one of the incident's alerts, or if it triggered one of those alerts (which is what happens when someone pages by calling in, and that call raises the alert). To find everything that is not related to an incident, use "not_in": curl --get 'https://api.incident.io/v2/escalations' \ --data 'incident[not_in]=ABC' ### By created_at and updated_at Find all escalations that follow specified date parameters for created_at and updated_at fields. Possible values are "gte" (greater than or equal to), "lte" (less than or equal to), and "date_range" (between two dates). For example, to find all escalations updated after 2025-01-01: curl --get 'https://api.incident.io/v2/escalations' \ --data 'updated_at[gte]=2025-01-01' To find all escalations created between 2025-01-01 and 2025-01-31: curl --get 'https://api.incident.io/v2/escalations' \ --data 'created_at[date_range]=2025-01-01~2025-01-31'
GET /v2/escalations - Read
CheckEscalationPermissions Escalations V2
Check whether the given users can currently acknowledge, decline, or snooze an escalation. This is a read-only projection of the escalation's current state, intended for deciding which response actions to surface to each user in a custom integration. To use this API, you will need an API key that can view escalations and users.
POST /v2/escalations/{escalation_id}/actions/check_permissions - Read
Show Escalations V2
Show a specific escalation.
GET /v2/escalations/{id} - Read
List Follow-ups V2
Deprecated: this endpoint will be removed on 31 December 2026. Use <code>GET /v3/follow_ups</code> instead. List all follow-ups for an organisation.
GET /v2/follow_ups - Read
Show Follow-ups V2
Deprecated: this endpoint will be removed on 31 December 2026. Use <code>GET /v3/follow_ups/{id}</code> instead. Get a single incident follow-up.
GET /v2/follow_ups/{id} - Read
List Glossary Entries V2
List glossary entries for this organisation, in rank order.
GET /v2/glossary_entries - Read
Show Glossary Entries V2
Get a single glossary entry.
GET /v2/glossary_entries/{id} - Read
Ping Heartbeat V2
Send a heartbeat ping for the specified alert source. Records a ping, indicating that the monitored job or service is healthy. The heartbeat monitor uses these pings to detect missed heartbeats and fire alerts. Both GET and POST are accepted
GET /v2/heartbeat/{alert_source_config_id}/ping - Read
List Incident Activity Log Entries V2
List the activity log entries for an incident, oldest first. If the incident has streams, this returns their entries too, and incident_id on each entry tells you which stream it came from. Platform noise is left out: channel joins and leaves, chat messages and call transcript fragments are recorded internally but never returned here.
GET /v2/incident_activity_log_entries - Read
ListIncidentAlerts Alerts V2
List the connections between incidents and alerts
GET /v2/incident_alerts - Read
List IncidentParticipantWorkloads V2
List the participants of an incident with their workload. We calculate how much time each participant has spent working on the incident, aggregated per participant. Each participant is annotated with their participant type and, if they have left the incident, when they were archived. Workload is calculated periodically, so values can lag real time and the most recent period may still be filling. The metadata reports the time the figures are calculated up to. Workload for private incidents is only returned to API keys with the `incident_workloads.view_private` scope.
GET /v2/incident_participant_workloads - Read
List IncidentParticipants V2
List the participants of an incident with the role they took. Participants are split into those who are actively helping with the incident and those who are just observing. Each participant is annotated with their participant type.
GET /v2/incident_participants - Read
List Incident Roles V2
List all incident roles for an organisation.
GET /v2/incident_roles - Read
Show Incident Roles V2
Get a single incident role.
GET /v2/incident_roles/{id} - Read
List Incident Timeline Items V2
List the timeline items for an incident, oldest first. Items are ordered by timestamp, then by ID to break ties, which is the order the dashboard shows them in. If the incident has streams, this returns the items on its streams too - they're part of the same narrative - and incident_id on each item tells you which stream it came from. Items can be edited after they're written, and this endpoint always returns their current state, so listing an incident again gives you the timeline as it stands today.
GET /v2/incident_timeline_items - Read
List Incident Timestamps V2
List all incident timestamps for an organisation.
GET /v2/incident_timestamps - Read
Show Incident Timestamps V2
Get a single incident timestamp.
GET /v2/incident_timestamps/{id} - Read
List Incident Updates V2
List all incident updates for an organisation, or for a specific incident.
GET /v2/incident_updates - Read
List Incidents V2
List all incidents for an organisation. This endpoint supports a number of filters, which can help find incidents matching certain criteria. Filters are provided as query parameters, but due to the dynamic nature of what you can query by (different accounts have different custom fields, statuses, etc) they are more complex than most. The maximum page size that can be requested is 250. To help, here are some exemplar curl requests with a human description of what they search for. Note that: - Filters may be combined using the filter_mode parameter: 'all' (default) requires all filters to match (AND logic), while 'any' requires at least one filter to match (OR logic). - IDs are normally in UUID format, but have been replaced with shorter strings to improve readability. - All query parameters must be URI encoded. ### By status With status of id=ABC, find all incidents that are set to that status: curl --get 'https://api.incident.io/v2/incidents' \ --data 'status[one_of]=ABC' Or all incidents that are not set to status with id=ABC: curl --get 'https://api.incident.io/v2/incidents' \ --data 'status[not_in]=ABC' ### By created_at or updated_at Find all incidents that follow specified date parameters for created_at and updated_at fields. Possible values are "gte" (greater than or equal to), "lte" (less than or equal to), and "date_range" (between two dates). The following example finds all incidents created before or on 2021-01-02T00:00:00Z: curl --get 'https://api.incident.io/v2/incidents' \ --data 'created_at[lte]=2021-01-02' To find incidents created within a specific date range, use the date_range option with tilde-separated dates: curl --get 'https://api.incident.io/v2/incidents' \ --data 'created_at[date_range]=2024-12-02~2024-12-08' ### By status category Find all incidents that are in a status category. Some categories use a different name in the API than the one shown in the dashboard — most notably "live" (shown as "Active") and "learning" (shown as "Post-incident"). The full mapping is: | API value | Shown in app as | | ---------- | --------------- | | triage | Triage | | live | Active | | learning | Post-incident | | paused | Paused | | closed | Closed | | declined | Declined | | canceled | Canceled | | merged | Merged | For example, to find all incidents the dashboard shows as "Active", filter on the "live" category: curl --get 'https://api.incident.io/v2/incidents' \ --data 'status_category[one_of]=live' Or all incidents that are not in a status category: curl --get 'https://api.incident.io/v2/incidents' \ --data 'status_category[not_in]=live' ### By severity With severity of id=ABC, find all incidents that are set to that severity: curl --get 'https://api.incident.io/v2/incidents' \ --data 'severity[one_of]=ABC' Or all incidents where severity rank is greater-than-or-equal-to the rank of severity id=ABC: curl --get 'https://api.incident.io/v2/incidents' \ --data 'severity[gte]=ABC' Or all incidents where severity rank is less-than-or-equal-to the rank of severity id=ABC: curl --get 'https://api.incident.io/v2/incidents' \ --data 'severity[lte]=ABC' ### By incident type With incident type of id=ABC, find all incidents that are of that type: curl --get 'https://api.incident.io/v2/incidents' \ --data 'incident_type[one_of]=ABC' Or all incidents not of that type: curl --get 'https://api.incident.io/v2/incidents' \ --data 'incident_type[not_in]=ABC' ### By incident mode By default, we return standard and retrospective incidents. This means that test and tutorial incidents are filtered out. To override this behaviour, you can use the mode filter to specify which modes you want to get. To find incidents of all modes: curl --get 'https://api.incident.io/v2/incidents' \ --data 'mode[one_of]=standard&mode[one_of]=retrospective&mode[one_of]=test&mode[one_of]=tutorial' To find just test incidents: curl --get 'https://api.incident.io/v2/incidents' \ --data 'mode[one_of]=test' ### By incident role Roles and custom fields have another nested layer in the query parameter, to account for operations against any of the roles or custom fields created in the account. With incident role id=ABC, find all incidents where that role is unset: curl --get 'https://api.incident.io/v2/incidents' \ --data 'incident_role[ABC][is_set]=true' Or where the role has been set: curl --get 'https://api.incident.io/v2/incidents' \ --data 'incident_role[ABC][is_set]=false' ### By option custom fields With an option custom field id=ABC, all incidents that have field ABC set to the custom field option of id=XYZ: curl \ --get 'https://api.incident.io/v2/incidents' \ --data 'custom_field[ABC][one_of]=XYZ' Or all incidents that do not have custom field id=ABC set to option id=XYZ: curl \ --get 'https://api.incident.io/v2/incidents' \ --data 'custom_field[ABC][not_in]=XYZ' ### Sorting By default, results are ordered by their creation date. You can use the sort_by parameter to reverse this order: curl \ --get 'https://api.incident.io/v2/incidents' \ --data 'sort_by=created_at_oldest_first'
GET /v2/incidents - Read
Show Incidents V2
Get a single incident. The ID supplied can be either the incident's full ID, or the numeric part of its reference. For example, to get INC-123, you could use either its full ID or: curl \ --get 'https://api.incident.io/v2/incidents/123
GET /v2/incidents/{id} - Read
List On-call Notification Pauses V2
List on-call notification pauses across the organisation. By default this returns pauses that are active now or scheduled for the future. Cancelled pauses are never returned, and pauses that were resumed early have ends_at set to when they were resumed.
GET /v2/on_call_notification_pauses - Read
Show On-call Notification Pauses V2
Show a single on-call notification pause. Cancelled pauses are not found.
GET /v2/on_call_notification_pauses/{id} - Read
List Pay Configs V2
List pay configs for this organisation. Returns published configs, and drafts created through the API, which belong to nobody and so are visible to everyone. A draft a person created in the dashboard stays private to them. Archived configs are never returned.
GET /v2/pay_configs - Read
Show Pay Configs V2
Show a single pay config.
GET /v2/pay_configs/{id} - Read
ListOneOffRules Pay Configs V2
List a pay config's one-off rules, in no particular order. They take precedence over weekly rules, and may not overlap, so at most one applies to any moment.
GET /v2/pay_configs/{pay_config_id}/one_off_rules - Read
ShowOneOffRule Pay Configs V2
Show a single one-off rule.
GET /v2/pay_configs/{pay_config_id}/one_off_rules/{id} - Read
ListWeeklyRules Pay Configs V2
List a pay config's weekly rules, in evaluation order. A shift is priced by the first rule that covers it, so order is meaningful. A created rule goes last, and there is no way to reorder rules once set: to put one earlier, replace the config through its own create endpoint.
GET /v2/pay_configs/{pay_config_id}/weekly_rules - Read
ShowWeeklyRule Pay Configs V2
Show a single weekly rule.
GET /v2/pay_configs/{pay_config_id}/weekly_rules/{id} - Read
List Pay Reports V2
List pay reports, newest first. Only reports that have finished generating are listed. A report you have just asked for appears once it is complete. Fetch it by ID to follow its progress, or to see why it failed. Reports created before the current pay report format have no totals, so check that total_duration_seconds is set before reading either total. Drafts are returned alongside published reports. Check published_at to tell them apart. Only the headline totals are returned: the shifts behind them, and the per-user and per-schedule breakdowns, come from downloading the report.
GET /v2/pay_reports - Read
Show Pay Reports V2
Get a single pay report. This is how you follow up a report you asked for: status says whether it is still being generated, and error_code and error_message say why it will never be.
GET /v2/pay_reports/{id} - Read
Download Pay Reports V2
Download a pay report as CSV. One row per user, carrying what they earned over the report's window and how long they were on-call for it. Each value appears twice: once formatted for a person to read, and once as an integer for a system to parse. Only a report that has finished generating can be downloaded, since an incomplete one has no totals to write. Check the report's status first.
GET /v2/pay_reports/{id}/download - Read
List Policies V2
List all policies for an organisation.
GET /v2/policies - Read
Show Policies V2
Get a single policy.
GET /v2/policies/{id} - Read
List Policy Findings V2
List the findings your policies have raised, whatever state they are in.
GET /v2/policy_findings - Read
Show Policy Findings V2
Get a single finding.
GET /v2/policy_findings/{id} - Read
ListScheduleEntries Schedules V2
List the schedule entries for a schedule over a window of time. Use this endpoint to find out who is on-call for a schedule, either right now or at any point in the future. Common uses include: - Building a calendar or timeline view of who is on-call. - Looking up who was on-call at a particular moment (for example, when an incident fired). - Exporting upcoming shifts into another system, such as a payroll or scheduling tool. The response groups entries into three lists: `scheduled` (the entries the rotation rules produce, before any overrides), `overrides` (any one-off overrides that apply in the window) and `final` (the effective schedule after overrides have been merged in — this is normally the list you want). Each entry includes the `rotation_id` it belongs to. Schedules can be made up of multiple rotations (for example, a primary and a secondary rotation) and each rotation can have several layers, and we return entries for every rotation and layer on the schedule. The endpoint returns all entries that overlap with the given window. If no window is provided we default to a sensible range starting from now. ## Pagination Responses are paginated. When more entries are available than fit on a single page, the response includes a `pagination_meta` block with two fields: - `after_url` — a fully-formed URL for the next page. The simplest way to paginate is to keep following this URL until it is no longer present. - `after` — an opaque cursor token. To fetch the next page manually, re-issue the request with `entry_window_start` set to this value and `entry_window_end` left unchanged from the original request. Treat the token as opaque — do not parse or modify it. Keep paginating until `pagination_meta` is absent from the response, at which point you have received every entry in the window.
GET /v2/schedule_entries - Read
ListOverrides Schedules V2
List the overrides on a schedule. Overrides are one-off changes layered on top of the rotations, such as someone covering a colleague's shift. This returns the overrides themselves: to see the effective schedule with overrides already merged in, use the schedule entries endpoint instead. Overrides belong to a specific layer of a specific rotation, so you can narrow the results with `rotation_id` and `layer_id`. Archived overrides are not returned.
GET /v2/schedule_overrides - Read
ShowOverride Schedules V2
Get a single schedule override. Overrides that have been deleted are not returned. An override's ID is not stable across edits: updating an override that overlaps its neighbours replaces them with new overrides, so an ID you are holding can stop resolving. List the schedule's overrides again to pick up the replacements.
GET /v2/schedule_overrides/{id} - Read
List Schedule Sync Targets V2
List all schedule sync targets for this organisation.
GET /v2/schedule_sync_targets - Read
Show Schedule Sync Targets V2
Get a single schedule sync target.
GET /v2/schedule_sync_targets/{id} - Read
List Schedules V2
List configured schedules.
GET /v2/schedules - Read
Show Schedules V2
Get a single schedule.
GET /v2/schedules/{id} - Read
PreviewScheduleEntries Schedules V2
Preview the schedule entries that would be generated by a proposed schedule configuration. Use this endpoint before updating a schedule to see who would be on-call if you saved the supplied schedule payload. The request body uses the same `schedule` payload shape as Update schedule, so you can send the configuration you intend to save without persisting it. The response uses the same `schedule_entries` envelope as List schedule entries: `scheduled` contains entries produced by the rotation rules, `overrides` contains matching overrides, and `final` contains the effective schedule after overrides are applied. The preview window is bounded to keep requests predictable. If you ask for more than 91 days, the response is capped to 91 days from `entry_window_start`.
POST /v2/schedules/{id}/actions/preview_entries - Read
ListScheduleReplicas Schedules V2
List all replicas for a schedule.
GET /v2/schedules/{schedule_id}/replicas - Read
ShowScheduleReplica Schedules V2
Get a single schedule replica.
GET /v2/schedules/{schedule_id}/replicas/{id} - Read
ListScheduleSyncRules Schedules V2
List the sync rules configured on this schedule.
GET /v2/schedules/{schedule_id}/sync_rules - Read
ShowScheduleSyncRule Schedules V2
Get a single sync rule for a schedule.
GET /v2/schedules/{schedule_id}/sync_rules/{id} - Read
List Secrets V2
List all secrets for this organisation. Returns metadata only, never values.
GET /v2/secrets - Read
Show Secrets V2
Show a single secret's metadata, including its version history. Never returns values.
GET /v2/secrets/{id} - Read
List Status Page Components V2
List all status page components for an organisation.
GET /v2/status_page_components - Read
Show Status Page Components V2
Show a single status page component.
GET /v2/status_page_components/{id} - Read
ListStatusPageIncidents Status Pages V2
List status page incidents. This endpoint requires a valid API key but no specific scopes.
GET /v2/status_page_incidents - Read
ShowStatusPageIncident Status Pages V2
Show a status page incident. This endpoint requires a valid API key but no specific scopes.
GET /v2/status_page_incidents/{status_page_incident_id} - Read
ListStatusPageMaintenances Status Pages V2
List status page maintenances. This endpoint requires a valid API key but no specific scopes.
GET /v2/status_page_maintenances - Read
ShowStatusPageMaintenance Status Pages V2
Show a status page maintenance window. This endpoint requires a valid API key but no specific scopes.
GET /v2/status_page_maintenances/{status_page_maintenance_id} - Read
ShowStatusPageStructure Status Pages V2
Show the structure of a status page. This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page, with their display settings, and how the page shows uptime. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
GET /v2/status_page_structures/{status_page_id} - Read
ListStatusPages Status Pages V2
List all status pages for your organisation. This endpoint requires a valid API key but no specific scopes. Use this to find status page IDs for use in other endpoints.
GET /v2/status_pages - Read
ShowStatusPage Status Pages V2
Show a single status page. This endpoint requires a valid API key but no specific scopes. Use ShowStatusPageStructure to see the components and groups configured on the page.
GET /v2/status_pages/{status_page_id} - Read
ShowStatusPageComponentAvailability Status Pages V2
Show availability for a status page component over a time window. Pass start_at and end_at as RFC3339 timestamps. The window cannot be longer than 366 days. Availability uses the same rules as the public status page: full and partial outages count as downtime, overlapping impacts are merged, and time before we have data for the component is excluded rather than counted as up. This endpoint requires a valid API key but no specific scopes. Use ListStatusPages and ShowStatusPageStructure to find status page and component IDs.
GET /v2/status_pages/{status_page_id}/components/{component_id}/availability - Read
List Users V2
List users in your account.
GET /v2/users - Read
Show Users V2
Get a single user.
GET /v2/users/{id} - Read
ListNotificationMethods Users V2
List notification methods for a user. Phone numbers are partially redacted unless the API key holds the notification_methods.view_unredacted scope.
GET /v2/users/{user_id}/notification_methods - Read
ListNotificationRules Users V2
List notification rules for a user. Rules define how and when a user is notified for on-call pages. Only includes high_urgency and low_urgency rules; shift_changes rules are not returned.
GET /v2/users/{user_id}/notification_rules - Read
ShowPagingProvider Users V2
Show the paging provider that would be used to escalate to this user. Reflects their explicit preference if set; otherwise resolves to the effective fallback (typically `native` for on-call seat users, or a linked external provider otherwise). May be omitted only when the user cannot be escalated to at all (no seat and no linked external user).
GET /v2/users/{user_id}/paging_provider - Read
List WorkflowRuns V2
List workflow runs, newest first. Cancelled runs are never returned. The webhook delivery on each step omits the headers and bodies. Fetch a single run to see them. You can filter on when a run was created: ``` # Runs created on or after a date curl 'https://api.incident.io/v2/workflow_runs?created_at[gte]=2026-07-01' # Runs created on or before a date curl 'https://api.incident.io/v2/workflow_runs?created_at[lte]=2026-07-31' # Runs created between two dates curl 'https://api.incident.io/v2/workflow_runs?created_at[date_range]=2026-07-01~2026-07-31' ``` Paginate by passing the last run's ID as `after`. The response's `pagination_meta.after` carries the value to send next, and is absent on the last page. An `after` that isn't a run in your organisation returns 404.
GET /v2/workflow_runs - Read
Show WorkflowRuns V2
Show a single workflow run, including the full webhook delivery for any step that sent one. A delivery is kept for 7 days. After that `webhook_delivery_state` becomes `expired` and the delivery itself is absent: the step still ran and may well have succeeded, so an expired delivery must not be read as a failure. This may return a cancelled run, in which case `cancelled_at` is set.
GET /v2/workflow_runs/{id} - Read
ListWorkflows Workflows V2
List all workflows
GET /v2/workflows - Read
ShowWorkflow Workflows V2
Show a workflow by ID
GET /v2/workflows/{id} - Read
List Actions V3
List actions for an organisation. Results are paginated and ordered by action ID, oldest first. Use the <code>after</code> value from <code>pagination_meta</code> to fetch the next page; it is only set when there may be more results. ### By created_at and updated_at Both timestamp filters accept the operators "gte" (greater than or equal to), "lte" (less than or equal to) and "date_range" (between two dates). The following example finds all actions updated after 2025-01-01: curl --get 'https://api.incident.io/v3/actions' \ --data 'updated_at[gte]=2025-01-01T00:00:00Z' To find actions created within a specific date range, use the date_range operator with tilde-separated dates: curl --get 'https://api.incident.io/v3/actions' \ --data 'created_at[date_range]=2024-12-02~2024-12-08' Filtering on updated_at is useful for incrementally syncing actions: poll with updated_at[gte] set to your last sync time instead of re-fetching the full history. Two caveats: updated_at moves whenever the action row itself is written, but changes to embedded objects (e.g. an assignee being renamed) can alter the payload without bumping it. And timestamps are stamped before commit, so an action can become visible with an older updated_at than rows you have already seen — overlap your sync window by a few minutes to allow for writes that commit out of timestamp order.
GET /v3/actions - Read
Show Actions V3
Get a single incident action.
GET /v3/actions/{id} - Read
List Alert Routes V3
List all alert routes in your account.
GET /v3/alert_routes - Read
Show Alert Routes V3
Load details about a specific alert route in your account.
GET /v3/alert_routes/{id} - Read
ListEntries Catalog V3
List entries for a catalog type.
GET /v3/catalog_entries - Read
ShowEntry Catalog V3
Show a single catalog entry.
GET /v3/catalog_entries/{id} - Read
ListResources Catalog V3
List available engine resources for the catalog. A resource represents a type of data that can be held within the catalog, so this endpoint can be used to see what attribute types can be used when updating the schema of a catalog type.
GET /v3/catalog_resources - Read
ListTypes Catalog V3
List all catalog types for an organisation, including those synced from external resources.
GET /v3/catalog_types - Read
ShowType Catalog V3
Show a single catalog type.
GET /v3/catalog_types/{id} - Read
List Follow-ups V3
List follow-ups for an organisation. Results are paginated and ordered by follow-up ID, oldest first. Use the <code>after</code> value from <code>pagination_meta</code> to fetch the next page; it is only set when there may be more results. ### By created_at and updated_at Both timestamp filters accept the operators "gte" (greater than or equal to), "lte" (less than or equal to) and "date_range" (between two dates). The following example finds all follow-ups updated after 2025-01-01: curl --get 'https://api.incident.io/v3/follow_ups' \ --data 'updated_at[gte]=2025-01-01T00:00:00Z' To find follow-ups created within a specific date range, use the date_range operator with tilde-separated dates: curl --get 'https://api.incident.io/v3/follow_ups' \ --data 'created_at[date_range]=2024-12-02~2024-12-08' Filtering on updated_at is useful for incrementally syncing follow-ups: poll with updated_at[gte] set to your last sync time instead of re-fetching the full history. Two caveats: updated_at moves whenever the follow-up row itself is written, but changes to embedded objects (e.g. an assignee being renamed, or an external issue's status text) can alter the payload without bumping it. And timestamps are stamped before commit, so a follow-up can become visible with an older updated_at than rows you have already seen — overlap your sync window by a few minutes to allow for writes that commit out of timestamp order.
GET /v3/follow_ups - Read
Show Follow-ups V3
Get a single incident follow-up.
GET /v3/follow_ups/{id} - Read
List Incident Forms V3
List incident forms for your account, including their elements and expressions.
GET /v3/incident_forms - Read
Show Incident Forms V3
Get a single incident form, including its elements and expressions.
GET /v3/incident_forms/{id} - Read
List Teams V3
List all teams in the organisation.
GET /v3/teams - Read
Show Teams V3
Get a single team.
GET /v3/teams/{id} - Write
Create Alert Notes V1
Add a note to an alert.
POST /v1/alert_notes - Write
Create API Keys V1
Create a new API key. The calling API key can only assign roles whose scopes are a subset of its own. The `api_keys_manage` role cannot be assigned via the API. An organization can have a maximum of 5000 active API keys. This endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.
POST /v1/api_keys - Write
Update API Keys V1
Update an existing API key's name, roles, or team assignments. All fields must be provided (PUT semantics). The calling API key can only assign roles whose scopes are a subset of its own. An API key cannot edit itself, and the `api_keys_manage` role cannot be assigned via the API. This endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.
PUT /v1/api_keys/{id} - Write
Rotate API Keys V1
Rotate the access token for an API key. This generates a new bearer token and optionally keeps the old token valid for a configurable grace period (up to 60 minutes), allowing a seamless rollover without downtime. The calling API key must have all the scopes of the key being rotated. This endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.
POST /v1/api_keys/{id}/actions/rotate - Write
Create Custom Field Options V1
Create a custom field option. If the sort key is not supplied, it'll default to 1000, so the option appears near the end of the list.
POST /v1/custom_field_options - Write
Update Custom Field Options V1
Update a custom field option
PUT /v1/custom_field_options/{id} - Write
Create Custom Fields V1
Create a new custom field
POST /v1/custom_fields - Write
Update Custom Fields V1
Update the details of a custom field
PUT /v1/custom_fields/{id} - Write
Create Incident Attachments V1
Attaches an external resource to an incident. You must provide a resource with resource_type and either external_id or url, but not both. When providing a url, the server will create the attachment from that link for the given resource type if the integration is installed and the link is valid. To attach an arbitrary link that isn't backed by an integration, use the arbitrary_url resource type with a url, and optionally a title and emoji.
POST /v1/incident_attachments - Write
Create Incident Memberships V1
Makes a user a member of a private incident
POST /v1/incident_memberships - Write
Create Incident Roles V1
Create a new incident role
POST /v1/incident_roles - Write
Update Incident Roles V1
Update an existing incident role
PUT /v1/incident_roles/{id} - Write
Create Incident Statuses V1
Create a new incident status
POST /v1/incident_statuses - Write
Update Incident Statuses V1
Update an existing incident status
PUT /v1/incident_statuses/{id} - Write
Create Incident Team Memberships V1
Grants a team access to a private incident
POST /v1/incident_team_memberships - Write
Create Incident Templates V1
Create an incident template.
POST /v1/incident_templates - Write
Update Incident Templates V1
Update an incident template. This is a full replacement: any field not supplied is cleared.
PUT /v1/incident_templates/{id} - Write
Create Incidents V1
Create a new incident.
POST /v1/incidents - Write
UpdateIPAllowlist IPAllowlists V1
Update the IP allowlist for your organisation
PUT /v1/ip_allowlists - Write
Create MaintenanceWindows V1
Create a new maintenance window.
POST /v1/maintenance_windows - Write
Attach PostmortemDocuments V1
Link an externally-hosted post-mortem document to an incident. Use this to attach a retrospective document you've created in your own provider (for example Confluence, Notion, or Google Docs) to an existing incident. This is the API equivalent of pasting a document link into the incident.io dashboard, and is useful for automating your retrospective workflow - for example, creating a document in the right space with the right permissions when an incident is opened, then linking it back to the incident. Only one external post-mortem can be attached to an incident, and you cannot attach an external document to an incident that already has an in-app post-mortem. Re-attaching the same incident with a new permalink updates the existing link.
POST /v1/postmortem_documents/actions/attach - Write
UpdateStatus PostmortemDocuments V1
Update the status of a post-mortem document.
PUT /v1/postmortem_documents/{id} - Write
Create Severities V1
Create a new severity
POST /v1/severities - Write
Update Severities V1
Update an existing severity
PUT /v1/severities/{id} - Write
Create Actions V2
Deprecated: this endpoint will be removed on 31 December 2026. Use <code>POST /v3/actions</code> instead. Create a new incident action.
POST /v2/actions - Write
Create Alert Attachments V2
Attach a URL to an alert or alert group. Provide exactly one of alert_id or alert_group_id. A URL for a ticket or pull request from a connected integration is attached as that ticket or pull request. Any other URL is attached as a link. A URL that is already attached returns a 422.
POST /v2/alert_attachments - Write
Create Alert Attributes V2
Create a new alert attribute.
POST /v2/alert_attributes - Write
Update Alert Attributes V2
Update an alert attribute.
PUT /v2/alert_attributes/{id} - Write
CreateHTTP Alert Events V2
Create an alert event using an HTTP source.
POST /v2/alert_events/http/{alert_source_config_id} - Write
Create Alert Sources V2
Create a new alert source in your account.
POST /v2/alert_sources - Write
AddTags Alerts V2
Add tags to an alert without changing its existing tags. Each tag is a name. A name that does not exist is created, except on private alerts, where only names already in the organisation's tag vocabulary can be used. Tags that are already present are ignored.
POST /v2/alerts/{id}/actions/add_tags - Write
Resolve Alerts V2
Resolve a currently firing alert. This marks the alert as resolved with the current time, attributing the resolution to the API key that made the request. Resolving an already-resolved alert is a no-op and returns the alert unchanged. Some alert sources are 'externally resolved' (for example, Datadog) — those alerts can only be resolved by the third-party system itself, and this endpoint will return a 422 explaining that. Private alerts: an API key without the 'view all alerts' scope can only resolve non-private alerts; private alerts will return a 404. Grant the API key a role that includes the global alerts access scope to resolve private alerts.
POST /v2/alerts/{id}/actions/resolve - Write
Create Announcement Templates V2
Create an announcement template.
POST /v2/announcement_templates - Write
CreateAllowedCaller Call Routes V2
Allow a number to call this route.
POST /v2/call_routes/{call_route_id}/allowed_callers - Write
CreateEntry Catalog V2
Create an entry within the catalog. We support a maximum of 50,000 entries per type. If you call this API with a payload where the external_id and catalog_type_id match an existing entry, the existing entry will be updated.
POST /v2/catalog_entries - Write
UpdateEntry Catalog V2
Updates an existing catalog entry.
PUT /v2/catalog_entries/{id} - Write
CreateType Catalog V2
Create a catalog type. The schema must be updated using the UpdateTypeSchema endpoint.
POST /v2/catalog_types - Write
UpdateType Catalog V2
Updates an existing catalog type. The schema must be updated using the UpdateTypeSchema endpoint.
PUT /v2/catalog_types/{id} - Write
UpdateTypeSchema Catalog V2
Update an existing catalog types schema, adding or removing attributes. Updating the schema is handled separately from creating and updating types, so that you don't have to worry about dependencies between types. For example, if type A has an attribute that relies on type B, you would have to create type B first. By allowing the creation of types without a schema, they can be created in any order, but it means that you need to make a separate call to this endpoint to update the schema.
POST /v2/catalog_types/{id}/actions/update_schema - Write
Create Custom Fields V2
Create a new custom field
POST /v2/custom_fields - Write
Update Custom Fields V2
Update the details of a custom field
PUT /v2/custom_fields/{id} - Write
Create Escalations V2
Create an escalation. An escalation pages people, either according to an escalation path, or directly to specific users. You must provide either an escalation_path_id OR user_ids, but not both. When escalating via an escalation path, the escalation will follow the configured path with its levels and timeouts, using your default [alert priority](https://app.incident.io/~/settings/alerts/configuration/priorities). When escalating directly to users, they will receive a high-urgency notification, based on their notification rules. This endpoint is rate-limited to 60 requests per minute, since it is intended for interactive use cases (for example someone clicking a "escalate to team" button in your internal developer platform). To escalate based on automated alerts, we recommend sending events to an alert source instead. If your API key's permissions are scoped to teams, you can only escalate via an escalation path that one of those teams owns. Escalating directly to user_ids needs the permission at the account level, because an escalation aimed at a person has no owning team.
POST /v2/escalations - Write
RespondEscalation Escalations V2
Respond to an escalation. An API key can acknowledge or snooze an escalation on its own, and the response is attributed to the key. Declining ("nack") means "I personally can't take this page", so it isn't available to an API key responding in its own right. To use this API, you will need an API key with the "Create and manage escalations" permission.
POST /v2/escalations/{escalation_id}/actions/respond - Write
Create Follow-ups V2
Deprecated: this endpoint will be removed on 31 December 2026. Use <code>POST /v3/follow_ups</code> instead. Create a new incident follow-up.
POST /v2/follow_ups - Write
ConnectExternalIssue Follow-ups V2
Deprecated: this endpoint will be removed on 31 December 2026. Use <code>POST /v3/follow_ups/{id}/actions/connect_external_issue</code> instead. Connect a follow-up to an existing issue in an issue tracker, using the URL of the issue. This will not work if the follow-up is already connected to an external issue.
POST /v2/follow_ups/{id}/actions/connect_external_issue - Write
Create Glossary Entries V2
Create a glossary entry. It is appended to the end of the glossary unless after names an existing entry to insert it after.
POST /v2/glossary_entries - Write
UpdateRanks Glossary Entries V2
Reorder glossary entries. Every live entry must be included exactly once.
PUT /v2/glossary_entries/actions/update_ranks - Write
Update Glossary Entries V2
Update a glossary entry's term or description. Rank is unchanged; use the reorder action for that.
PUT /v2/glossary_entries/{id} - Write
Ping Heartbeat V2
Send a heartbeat ping for the specified alert source. Records a ping, indicating that the monitored job or service is healthy. The heartbeat monitor uses these pings to detect missed heartbeats and fire alerts. Both GET and POST are accepted
POST /v2/heartbeat/{alert_source_config_id}/ping - Write
CreateIncidentAlert Alerts V2
Attach an alert to an incident, creating the connection between them. The API key also needs the 'manage incident alerts' scope, which is what actually relates the alert once the connection exists. If the alert is already related to this incident, the existing connection is returned unchanged. If someone previously marked the alert as unrelated to this incident, that decision is preserved and this endpoint returns a 422 — set re_relate to override it. Private alerts can only be attached to private incidents, including when re_relate is set. An API key that cannot see the alert or the incident receives a 404. Busy incidents can be locked by another operation, in which case this endpoint returns a 409 and the request can be retried. Note that this endpoint returns 201 even when it re-relates or returns an existing connection rather than creating a new one.
POST /v2/incident_alerts - Write
Create Incident Roles V2
Create a new incident role
POST /v2/incident_roles - Write
Update Incident Roles V2
Update an existing incident role
PUT /v2/incident_roles/{id} - Write
Create Incident Timeline Items V2
Add a custom item to an incident's timeline. Items created here are custom, so they carry no activity_log_id and their timestamp stays editable. Set it to when the thing actually happened rather than when you're telling us about it - a deploy you shipped an hour ago belongs an hour back on the timeline. Every request needs an idempotency_key. Retrying with a key we've already seen returns the item the first request created rather than writing a second one, so an automation that retries on a timeout doesn't leave a duplicate behind.
POST /v2/incident_timeline_items - Write
Create Incident Updates V2
Share an update against an incident. An update can carry a message, move the incident to a new status, change its severity, or any combination of the three. At least one of them must be provided. Which permissions you need depends on what the update does: changing status requires permission to update an incident's status, and changing severity permission to update its severity.
POST /v2/incident_updates - Write
Create Incidents V2
Create a new incident. Note that if the incident mode is set to "retrospective" then the new incident will not be announced in Slack.
POST /v2/incidents - Write
ImportPostmortemDocument Incidents V2
Import a postmortem document from markdown into an incident. The document content should be provided as GitHub-Flavored Markdown. It will be parsed and converted into the collaborative editor format, and a new postmortem document will be created for the incident. If no main postmortem document exists for the incident, the imported document will become the main document.
POST /v2/incidents/{id}/actions/import_postmortem_document - Write
Create Pay Configs V2
Create a pay config. The config is created as a draft, and becomes visible to everyone in the organisation once a report that prices against it is published.
POST /v2/pay_configs - Write
Update Pay Configs V2
Update a pay config's attributes. This changes the config's name, timezone, currency and base rate. It does not touch the config's rules, which are set when the config is created. Updating a config that a published report priced against additionally requires the schedule_pay_configs.update_published scope, because it changes the explanation of pay someone has already been sent.
PUT /v2/pay_configs/{id} - Write
CreateOneOffRule Pay Configs V2
Add a one-off rule to a pay config. It may not overlap a rule the config already has. Where it lands in the list has no effect on pricing.
POST /v2/pay_configs/{pay_config_id}/one_off_rules - Write
UpdateOneOffRule Pay Configs V2
Update a one-off rule. It may not be moved to overlap another rule on the same config.
PUT /v2/pay_configs/{pay_config_id}/one_off_rules/{id} - Write
CreateWeeklyRule Pay Configs V2
Add a weekly rule to a pay config. The rule is added last, so it is evaluated after every rule already on the config.
POST /v2/pay_configs/{pay_config_id}/weekly_rules - Write
UpdateWeeklyRule Pay Configs V2
Update a weekly rule, leaving its position in the evaluation order alone.
PUT /v2/pay_configs/{pay_config_id}/weekly_rules/{id} - Write
Create Pay Reports V2
Request a pay report. Generating a report can take minutes for a wide date window, so this returns as soon as the request is accepted, with a report that has a status of pending and no totals. Fetch the report to find out how it went: it ends up either complete, with its totals filled in, or failed, with error_code and error_message saying why. Reports are created as drafts.
POST /v2/pay_reports - Write
Publish Pay Reports V2
Publish a draft pay report, making it visible to everyone in the organisation. Publishing emails the report to cc_emails. Set send_user_breakdowns to send if each user should also get their own pay breakdown, or skip if not.
POST /v2/pay_reports/{id}/actions/publish - Write
Create Policies V2
Create a new policy.
POST /v2/policies - Write
Restore Policy Findings V2
Undo a dismissal, returning the finding to its open state.
POST /v2/policy_findings/{id}/actions/restore - Write
CreateOverride Schedules V2
Create a new schedule override.
POST /v2/schedule_overrides - Write
Create Schedule Sync Targets V2
Create a new schedule sync target for a Slack user group.
POST /v2/schedule_sync_targets - Write
Create Schedules V2
Create a new schedule.
POST /v2/schedules - Write
CreateScheduleReplica Schedules V2
Create a new schedule replica.
POST /v2/schedules/{schedule_id}/replicas - Write
CreateScheduleSyncRule Schedules V2
Create a new sync rule linking a schedule to a sync target.
POST /v2/schedules/{schedule_id}/sync_rules - Write
Create Secrets V2
Create a new secret with its initial value.
POST /v2/secrets - Write
Update Secrets V2
Update a secret's metadata. Does not change the value: use the rotate action for that.
PUT /v2/secrets/{id} - Write
Rotate Secrets V2
Rotate a secret's value, replacing the current value with a new one. The previous value is retired and can no longer be read.
POST /v2/secrets/{id}/actions/rotate - Write
Create Status Page Components V2
Create a status page component. Placement on a page is controlled separately via status page structures. This endpoint requires an API key with the "Manage organization settings (e.g. custom fields)" scope.
POST /v2/status_page_components - Write
Update Status Page Components V2
Update a status page component's name and description. This endpoint requires an API key with the "Manage organization settings (e.g. custom fields)" scope.
PUT /v2/status_page_components/{id} - Write
CreateStatusPageIncidentUpdate Status Pages V2
Post an update on a Status Page incident. This is the endpoint to use when resolving an incident - set incident_status to "resolved" to end the incident. There is a limit of 100 updates per incident. This endpoint requires an API key with the "Create status page incidents, status page maintenance windows, and publish status page updates" scope.
POST /v2/status_page_incident_updates - Write
CreateStatusPageIncident Status Pages V2
Create a status page incident. This endpoint requires an API key with the "Create status page incidents, status page maintenance windows, and publish status page updates" scope.
POST /v2/status_page_incidents - Write
UpdateStatusPageIncident Status Pages V2
Update a status page incident. This endpoint requires an API key with the "Create status page incidents, status page maintenance windows, and publish status page updates" scope.
PUT /v2/status_page_incidents/{status_page_incident_id} - Write
CreateStatusPageMaintenanceUpdate Status Pages V2
Post an update on a Status Page maintenance window. This is the endpoint to use when completing a maintenance window - set maintenance_status to "maintenance_complete" to end the maintenance. There is a limit of 100 updates per maintenance window. This endpoint requires an API key with the "Create status page incidents, status page maintenance windows, and publish status page updates" scope.
POST /v2/status_page_maintenance_updates - Write
CreateStatusPageMaintenance Status Pages V2
Schedule a Status Page maintenance window. This endpoint requires an API key with the "Create status page incidents, status page maintenance windows, and publish status page updates" scope.
POST /v2/status_page_maintenances - Write
UpdateStatusPageMaintenance Status Pages V2
Update the name and scheduled window of a Status Page maintenance window. The new start_at and end_at apply to every component this maintenance window affects. This does not publish an update to your status page and does not notify subscribers. Automated updates only move a window forwards, so one that has already started or completed will not move back to an earlier status. To move a status backwards, or to tell subscribers the schedule has changed, post a maintenance update to POST /status_page_maintenance_updates. This endpoint requires an API key with the "Create status page incidents, status page maintenance windows, and publish status page updates" scope.
PUT /v2/status_page_maintenances/{status_page_maintenance_id} - Write
CreateStatusPageRetrospectiveIncident Status Pages V2
Create a retrospective (historical) status page incident. Use this to backfill a completed incident with a reconstructed timeline of past updates, for example when migrating from another status page provider. Every update's published_at must be in the past, the updates must be ordered chronologically (earliest first), and the final update must set incident_status to "resolved". Retrospective incidents never notify subscribers. As this endpoint is intended for bulk historical backfill, it has a dedicated rate limit of 5 requests per second (with a burst allowance of 300 requests) per API key. If you exceed it you'll receive a 429 response with a Retry-After header; back off and retry to resume your backfill. This endpoint requires an API key with the "Create status page incidents, status page maintenance windows, and publish status page updates" scope.
POST /v2/status_page_retrospective_incidents - Write
UpdateDataSource Telemetry V2
Update the credentials or configuration of a telemetry data source. Provide only the config block that matches your data source type (e.g. grafana_config for Grafana, datadog_config for Datadog). New credentials are validated against the provider before being saved.
PUT /v2/telemetry/data_sources/{id} - Write
UpdatePagingProvider Users V2
Update a user's preferred paging provider.
POST /v2/users/{user_id}/paging_provider - Write
CreateWorkflow Workflows V2
Create a new workflow
POST /v2/workflows - Write
UpdateWorkflow Workflows V2
Updates a workflow
PUT /v2/workflows/{id} - Write
Create Actions V3
Create a new incident action.
POST /v3/actions - Write
CreateEntry Catalog V3
Create an entry within the catalog. We support a maximum of 50,000 entries per type. If you call this API with a payload where the external_id and catalog_type_id match an existing entry, the existing entry will be updated.
POST /v3/catalog_entries - Write
CreateType Catalog V3
Create a catalog type. The schema must be updated using the UpdateTypeSchema endpoint.
POST /v3/catalog_types - Write
UpdateType Catalog V3
Updates an existing catalog type. The schema must be updated using the UpdateTypeSchema endpoint.
PUT /v3/catalog_types/{id} - Write
UpdateTypeSchema Catalog V3
Update an existing catalog types schema, adding or removing attributes. Updating the schema is handled separately from creating and updating types, so that you don't have to worry about dependencies between types. For example, if type A has an attribute that relies on type B, you would have to create type B first. By allowing the creation of types without a schema, they can be created in any order, but it means that you need to make a separate call to this endpoint to update the schema.
POST /v3/catalog_types/{id}/actions/update_schema - Write
Create Follow-ups V3
Create a new incident follow-up.
POST /v3/follow_ups - Write
CreateFromLink Follow-ups V3
Create a follow-up from the URL of an issue that already exists in an issue tracker. The follow-up is created already connected to that issue, so it will not also be exported to a new one. Prefer this over creating a follow-up and then connecting it: that sequence races the automatic export, which can leave you with a duplicate issue or a connect call that fails because the export won. The follow-up's title, description and assignee are taken from the issue, and it is backdated to the issue's creation time. Its priority is taken from the issue only if your organisation has priority sync enabled, and otherwise falls back to your default priority. Issues that are already closed are accepted: the follow-up records the issue's completion time, though it is still created with an <code>outstanding</code> status until the next sync from the issue tracker. If your organisation requires a follow-up owner and the issue is unassigned, the incident lead is used instead. Where there is no incident lead either, this returns a validation error rather than creating an unowned follow-up.
POST /v3/follow_ups/actions/create_from_link - Write
ConnectExternalIssue Follow-ups V3
Connect a follow-up to an existing issue in an issue tracker, using the URL of the issue. This will not work if the follow-up is already connected to an external issue.
POST /v3/follow_ups/{id}/actions/connect_external_issue - Write
Create Incident Forms V3
Create an incident form for an incident type. A form that already exists for that form type and incident type is rejected.
POST /v3/incident_forms - Destructive
Delete Alert Notes V1
Delete an alert note.
DELETE /v1/alert_notes/{id} - Destructive
Update Alert Notes V1
Replace the content of an alert note.
PUT /v1/alert_notes/{id} - Destructive
Delete API Keys V1
Delete an existing API key. The calling API key does not need to hold the scopes of the key being deleted, but a team-scoped key can only delete keys belonging to its teams. This endpoint requires a valid API key with the `api_keys_manage` role at either the account level or team level.
DELETE /v1/api_keys/{id} - Destructive
Delete Custom Field Options V1
Delete a custom field option
DELETE /v1/custom_field_options/{id} - Destructive
Delete Custom Fields V1
Delete a custom field
DELETE /v1/custom_fields/{id} - Destructive
Delete Incident Attachments V1
Unattaches an external resource from an incident
DELETE /v1/incident_attachments/{id} - Destructive
Revoke Incident Memberships V1
Revoke a user's membership of a private incident
POST /v1/incident_memberships/actions/revoke - Destructive
Delete Incident Roles V1
Removes an existing role
DELETE /v1/incident_roles/{id} - Destructive
Delete Incident Statuses V1
Delete an incident status
DELETE /v1/incident_statuses/{id} - Destructive
Revoke Incident Team Memberships V1
Revoke a team's access to a private incident. Members who only had access through this team lose it too; directly-added members and members still covered by another team keep theirs.
POST /v1/incident_team_memberships/actions/revoke - Destructive
Destroy Incident Templates V1
Archive an incident template. Fails if the template is still referenced by an alert route.
DELETE /v1/incident_templates/{id} - Destructive
Delete MaintenanceWindows V1
Archives a maintenance window. Set force to archive an active window.
DELETE /v1/maintenance_windows/{id} - Destructive
Update MaintenanceWindows V1
Update an existing maintenance window.
PUT /v1/maintenance_windows/{id} - Destructive
Delete Severities V1
Delete a severity
DELETE /v1/severities/{id} - Destructive
Delete Actions V2
Deprecated: this endpoint will be removed on 31 December 2026. Use <code>DELETE /v3/actions/{id}</code> instead. Delete an incident action.
DELETE /v2/actions/{id} - Destructive
Update Actions V2
Deprecated: this endpoint will be removed on 31 December 2026. Use <code>PUT /v3/actions/{id}</code> instead. Update an existing incident action.
PUT /v2/actions/{id} - Destructive
Delete Alert Attachments V2
Remove an attachment from its alert or alert group.
DELETE /v2/alert_attachments/{id} - Destructive
Destroy Alert Attributes V2
Destroy an alert attribute.
DELETE /v2/alert_attributes/{id} - Destructive
Create Alert Routes V2
Create a new alert route in your account.
POST /v2/alert_routes - Destructive
Delete Alert Routes V2
Delete an existing alert route in your account.
DELETE /v2/alert_routes/{id} - Destructive
Update Alert Routes V2
Update an existing alert route in your account.
PUT /v2/alert_routes/{id} - Destructive
Delete Alert Sources V2
Delete an existing alert source in your account.
DELETE /v2/alert_sources/{id} - Destructive
Update Alert Sources V2
Update an existing alert source in your account.
PUT /v2/alert_sources/{id} - Destructive
RemoveTags Alerts V2
Remove tags from an alert without changing its other tags. Each tag is a name. Tags that are not present on the alert are ignored.
POST /v2/alerts/{id}/actions/remove_tags - Destructive
SetTags Alerts V2
Replace all tags on an alert. Each tag is a name. A name that does not exist is created, except on private alerts, where only names already in the organisation's tag vocabulary can be used. Passing an empty list removes every tag.
POST /v2/alerts/{id}/actions/set_tags - Destructive
Create Announcement Rules V2
Create an announcement rule.
POST /v2/announcement_rules - Destructive
Destroy Announcement Rules V2
Delete an announcement rule.
DELETE /v2/announcement_rules/{id} - Destructive
Update Announcement Rules V2
Update an announcement rule.
PUT /v2/announcement_rules/{id} - Destructive
Destroy Announcement Templates V2
Delete an announcement template. The default template, and templates still used by an announcement rule or workflow, can't be deleted.
DELETE /v2/announcement_templates/{id} - Destructive
Update Announcement Templates V2
Update an announcement template. Fields and actions are replaced wholesale, so send the full set you want.
PUT /v2/announcement_templates/{id} - Destructive
DestroyAllowedCaller Call Routes V2
Stop allowing a number to call this route. A route that only answers its allowed callers must keep at least one, so turn use_caller_allowlist off before removing the last number.
DELETE /v2/call_routes/{call_route_id}/allowed_callers/{id} - Destructive
UpdateAllowedCaller Call Routes V2
Replace an allowed caller's number and label.
PUT /v2/call_routes/{call_route_id}/allowed_callers/{id} - Destructive
CreateOption Call Routes V2
Add an option to a call route's phone-tree menu. Callers hear the menu instead of being routed down the route's own path, so adding the first option clears that path. Every plan allows a single option. A menu of two or more options is not on every plan, so get in touch if you need one enabled.
POST /v2/call_routes/{call_route_id}/options - Destructive
DestroyOption Call Routes V2
Remove an option from a call route's phone-tree menu. A route has to route calls somewhere, so give it a path before removing its last option.
DELETE /v2/call_routes/{call_route_id}/options/{id} - Destructive
UpdateOption Call Routes V2
Replace a phone-tree option. Two live options can't share a digit, so moving an option onto a digit the menu already uses is rejected.
PUT /v2/call_routes/{call_route_id}/options/{id} - Destructive
Update Call Routes V2
Replace a call route's configuration. Sending a path retires any phone-tree menu on the route. Send an empty path to keep the menu.
PUT /v2/call_routes/{id} - Destructive
DestroyEntry Catalog V2
Archives a catalog entry.
DELETE /v2/catalog_entries/{id} - Destructive
DestroyType Catalog V2
Archives a catalog type and associated entries.
DELETE /v2/catalog_types/{id} - Destructive
Delete Custom Fields V2
Delete a custom field
DELETE /v2/custom_fields/{id} - Destructive
Create Escalation Path Templates V2
Create a new escalation path template.
POST /v2/escalation_path_templates - Destructive
Destroy Escalation Path Templates V2
Archives a particular escalation path template.
DELETE /v2/escalation_path_templates/{id} - Destructive
Update Escalation Path Templates V2
Update a particular escalation path template.
PUT /v2/escalation_path_templates/{id} - Destructive
CreatePath Escalations V2
Create an escalation path. An escalation path is a series of steps that describe how a page should be escalated, represented as graph, supporting conditional branches based on alert priority and working intervals. We recommend you create escalation paths in the incident.io dashboard where our path builder makes it easy to use conditions and visualise the path.
POST /v2/escalation_paths - Destructive
DestroyPath Escalations V2
Archives an escalation path. We recommend you create escalation paths in the incident.io dashboard where our path builder makes it easy to use conditions and visualise the path.
DELETE /v2/escalation_paths/{id} - Destructive
UpdatePath Escalations V2
Updates an escalation path. We recommend you create escalation paths in the incident.io dashboard where our path builder makes it easy to use conditions and visualise the path.
PUT /v2/escalation_paths/{id} - Destructive
ReassignEscalation Escalations V2
Reassign an escalation to a different escalation path or set of users. Use this when a page reached the wrong people. Reassigning creates a new escalation aimed at the targets you give, linked back to the original, and carries over the original's title, description, priority, incident and alert so the page stays attached to the same alert and acknowledgements keep grouping under it. You must provide either an escalation_path_id OR user_ids, but not both. Both name incident.io escalation paths and users, so an escalation cannot be reassigned to an external escalator such as PagerDuty or Opsgenie. By default the original escalation is resolved, so the first targets stop being paged. Pass resolve_original=false to leave it running alongside the new one. Resolving the original additionally needs the "escalations.respond" permission, since it stops a page someone else may be responding to. An escalation can only be reassigned once: calling this again for the same escalation is rejected. Retrying a request whose response you never saw is safe in the sense that matters — a reassignment that already happened is never repeated, so nobody is paged twice — but the retry is rejected rather than returning the escalation the first call created, so keep the ID from the original response. To use this API, you will need an API key with the "Create and manage escalations" permission. The reassignment is attributed to the key; to attribute it to one of your users instead, set the X-Incident-User header, which needs the "api_keys.act_on_behalf_of_users" scope and no team permissions on the key. If your API key's permissions are scoped to teams, the escalation you're reassigning must be owned by one of those teams, and you can only reassign via an escalation path one of them owns. Reassigning directly to user_ids needs the permission at the account level, because an escalation aimed at a person has no owning team.
POST /v2/escalations/{escalation_id}/actions/reassign - Destructive
CancelEscalation Escalations V2
Cancel an escalation. Cancelling an escalation stops any further paging: notifications cease and the escalation will not advance to further levels or repeat. This works on escalations that are still paging (for example to silence a page when an incident is resolved before anyone acknowledges it) as well as snoozed ones. Escalations that have already resolved or expired cannot be cancelled, and cancelling an already-cancelled escalation is a no-op. To use this API, you will need an API key with the "Create and manage escalations" permission.
POST /v2/escalations/{id}/actions/cancel - Destructive
Delete Follow-ups V2
Deprecated: this endpoint will be removed on 31 December 2026. Use <code>DELETE /v3/follow_ups/{id}</code> instead. Delete an incident follow-up.
DELETE /v2/follow_ups/{id} - Destructive
Update Follow-ups V2
Deprecated: this endpoint will be removed on 31 December 2026. Use <code>PUT /v3/follow_ups/{id}</code> instead. Update an existing incident follow-up.
PUT /v2/follow_ups/{id} - Destructive
Destroy Glossary Entries V2
Delete a glossary entry. The entry is archived, which frees its term so the same item can be added again later.
DELETE /v2/glossary_entries/{id} - Destructive
TransitionIncidentAlert Alerts V2
Confirm or detach the connection between an alert and an incident. Set state to 'related' to confirm the connection, or 'unrelated' to detach the alert from the incident. The API key also needs the 'manage incident alerts' scope. A detached connection no longer appears in the list endpoint, which returns related connections only. Busy incidents can be locked by another operation, in which case this endpoint returns a 409 and the request can be retried.
POST /v2/incident_alerts/{id}/actions/transition - Destructive
Delete Incident Roles V2
Removes an existing role
DELETE /v2/incident_roles/{id} - Destructive
Update Incident Timeline Items V2
Edit a timeline item. Fields you leave out are unchanged, and an empty description removes it. Timestamp can only be changed on a custom item: a promoted one follows the activity it came from.
PATCH /v2/incident_timeline_items/{id} - Destructive
ConnectExternalIssue Incidents V2
Connect an existing issue in an issue tracker to an incident, as its external issue. The issue is synced using the given incident ticket template, as if incident.io had created it from that template. The next sync writes the incident's fields into the issue. This works whether or not automatic incident ticket creation is turned on. While it is off, no tickets are created for other incidents, and the incident's fields are not written into this issue until it is turned on. This needs the incidents.connect_external_issue scope, either across the organisation or from an incident role on this incident. This fails if the incident already has a different external issue (unless replace is true), or if the issue is already linked to another incident or follow-up. The ID supplied can be either the incident's full ID, or the numeric part of its reference.
POST /v2/incidents/{id}/actions/connect_external_issue - Destructive
Edit Incidents V2
Edit an existing incident. This endpoint allows you to edit the properties of an existing incident: e.g. set the severity or update custom fields. When using this endpoint, only fields that are provided will be edited (omitted fields will be ignored). The API key must have `incidents.view`, and the scope corresponding to each property it changes: - `incidents.update_name` for the name or the Slack channel name override - `incidents.update_summary` for the summary - `incidents.update_severity` for the severity - `incidents.update_status` for the status - `incidents.update_custom_fields` for custom fields - `incidents.update_timestamps` for timestamps - `incidents.update_role_assignments` for role assignments - `incident_calls.create` to set the call URL - `incident_calls.destroy` when replacing an existing call URL
POST /v2/incidents/{id}/actions/edit - Destructive
CreateManagedResource Managed Resources V2
Create or update the management record for a resource. This replaces any annotations already stored on it. The annotations set `managed_by`: - `incident.io/terraform/version` sets it to `terraform`. - `incident.io/is-managed-externally` sets it to `external`. If both keys are present, `external` wins. - Neither key sets it to `dashboard`. This doesn't change the resource's configuration, but `managed_by` controls whether it can be edited in the dashboard. Returning a schedule to `dashboard` also returns its sync rules and targets. The API key must have the update scope for the resource type, e.g. `schedules.update` for a schedule.
POST /v2/managed_resources - Destructive
Destroy Pay Configs V2
Delete a pay config. Reports already published against this config keep their own copy of it, so their figures do not change. Any schedule using it as a default loses that default.
DELETE /v2/pay_configs/{id} - Destructive
DestroyOneOffRule Pay Configs V2
Remove a one-off rule from a pay config. Time it covered falls back to the weekly rules.
DELETE /v2/pay_configs/{pay_config_id}/one_off_rules/{id} - Destructive
DestroyWeeklyRule Pay Configs V2
Remove a weekly rule from a pay config. Time it covered falls back to the base rate, or to a later rule that also covers it.
DELETE /v2/pay_configs/{pay_config_id}/weekly_rules/{id} - Destructive
Destroy Pay Reports V2
Delete a draft pay report, archiving it so it no longer appears in list or show. Published reports cannot be deleted. Unpublish them instead.
DELETE /v2/pay_reports/{id} - Destructive
Unpublish Pay Reports V2
Unpublish a published pay report, recording a reason it should not be used. A draft cannot be unpublished: delete it instead. Unpublishing is terminal: the report no longer appears in List or Show, and cannot be published again. The reason is shown to anyone who still has a permalink.
POST /v2/pay_reports/{id}/actions/unpublish - Destructive
Delete Policies V2
Archive a policy. Archived policies stop evaluating and no longer appear in the API.
DELETE /v2/policies/{id} - Destructive
Update Policies V2
Update an existing policy. The <code>policy_type</code> of an existing policy cannot be changed: sending a different type is rejected. Create a new policy instead.
PUT /v2/policies/{id} - Destructive
Dismiss Policy Findings V2
Dismiss a finding, so it stops being counted as open. Dismissing is a judgement that the finding doesn't need acting on, not that the resource now meets the policy. The finding stays queryable with a state of <code>dismissed</code>.
POST /v2/policy_findings/{id}/actions/dismiss - Destructive
DestroyOverride Schedules V2
Delete a schedule override, restoring whoever the rotations put on-call for that window. Deleting an override that has already been deleted succeeds, so it is safe to retry.
DELETE /v2/schedule_overrides/{id} - Destructive
UpdateOverride Schedules V2
Update a schedule override, moving its window or the rotation and layer it sits on. An override cannot be reassigned: send the user it already has, and delete and recreate it to put someone else on call for that window. Overrides on a layer cannot overlap, so widening one over its neighbour's window takes that time over. The neighbour is deleted, and any of its time left outside the new window comes back as new overrides with new IDs, so other override IDs on this layer may stop resolving — list the schedule's overrides again to pick up the replacements.
PUT /v2/schedule_overrides/{id} - Destructive
Destroy Schedule Sync Targets V2
Archive a schedule sync target. Will fail if any active sync rules reference this target.
DELETE /v2/schedule_sync_targets/{id} - Destructive
Update Schedule Sync Targets V2
Update the add_bot_to_group flag on a sync target. The change propagates to every schedule with an active sync rule pointing at this target; the entire operation aborts if the caller lacks edit permission on any of those schedules.
PUT /v2/schedule_sync_targets/{id} - Destructive
Destroy Schedules V2
Archives a single schedule. Will fail if the schedule has active replicas — remove all replicas before deleting.
DELETE /v2/schedules/{id} - Destructive
Update Schedules V2
Update a schedule. Updating a schedule replaces its entire configuration with the one you send, including any scheduled future versions of its rotations — fetch the schedule first and include every version you want to keep. To change who's in a rotation from a future date without affecting shifts before then, keep the current version unchanged and add another version of the same rotation with `effective_from` set to when the change should land — ideally an upcoming handover, so nobody is swapped mid-shift. You can check the effect of any configuration before saving it with Preview schedule entries.
PUT /v2/schedules/{id} - Destructive
DestroyScheduleReplica Schedules V2
Archives a single schedule replica, stopping incident.io from syncing on-call shifts to the external provider. As with disabling mirroring via the UI, this will remove any upcoming overrides that incident.io has created in the external schedule, restoring it to its original state. If multiple replicas target the same external schedule, overrides are only removed when the last replica pointing to that schedule is deleted. Note: override cleanup is supported for PagerDuty and Jira Service Management. Opsgenie does not support programmatic override deletion, so overrides must be removed manually.
DELETE /v2/schedules/{schedule_id}/replicas/{id} - Destructive
DestroyScheduleSyncRule Schedules V2
Archive a sync rule, unlinking the schedule from the sync target.
DELETE /v2/schedules/{schedule_id}/sync_rules/{id} - Destructive
UpdateScheduleSyncRule Schedules V2
Update a sync rule's sync_type and permanent members in place. If the rule's sync target is shared with other schedules, a sync_type change propagates to every linked schedule and the entire operation aborts if the caller lacks edit permission on any of them. Permanent members are scoped to this rule and never propagate.
PUT /v2/schedules/{schedule_id}/sync_rules/{id} - Destructive
Destroy Secrets V2
Delete a secret, permanently removing its value. Fails if the secret is still referenced by a workflow.
DELETE /v2/secrets/{id} - Destructive
Destroy Status Page Components V2
Archive a status page component. This endpoint requires an API key with the "Manage organization settings (e.g. custom fields)" scope.
DELETE /v2/status_page_components/{id} - Destructive
DeleteStatusPageMaintenance Status Pages V2
Delete a Status Page maintenance window. The maintenance window and its updates stop appearing on your public status page, links to it stop working, and a window that has not yet run publishes no further automated updates. This cannot be undone. Subscribers are not told the window has been deleted, so anyone already emailed about it will have updates for a maintenance window they can no longer find. This endpoint requires an API key with the "Create status page incidents, status page maintenance windows, and publish status page updates" scope.
DELETE /v2/status_page_maintenances/{status_page_maintenance_id} - Destructive
DestroyWorkflow Workflows V2
Archives a workflow
DELETE /v2/workflows/{id} - Destructive
Delete Actions V3
Delete an incident action.
DELETE /v3/actions/{id} - Destructive
Update Actions V3
Update an existing incident action.
PUT /v3/actions/{id} - Destructive
Create Alert Routes V3
Create a new alert route in your account.
POST /v3/alert_routes - Destructive
Delete Alert Routes V3
Delete an existing alert route in your account.
DELETE /v3/alert_routes/{id} - Destructive
Update Alert Routes V3
Update an existing alert route in your account.
PUT /v3/alert_routes/{id} - Destructive
BulkUpdateEntries Catalog V3
Update multiple catalog entries in a single operation. You can update up to 250 entries at once. This operation is atomic - either all entries are updated successfully, or none are updated.
POST /v3/catalog_entries/actions/bulk_update - Destructive
DestroyEntry Catalog V3
Archives a catalog entry.
DELETE /v3/catalog_entries/{id} - Destructive
UpdateEntry Catalog V3
Updates an existing catalog entry.
PUT /v3/catalog_entries/{id} - Destructive
DestroyType Catalog V3
Archives a catalog type and associated entries.
DELETE /v3/catalog_types/{id} - Destructive
Delete Follow-ups V3
Delete an incident follow-up.
DELETE /v3/follow_ups/{id} - Destructive
Update Follow-ups V3
Update an existing incident follow-up.
PUT /v3/follow_ups/{id} - Destructive
Delete Incident Forms V3
Archive an incident form. The organisation's default form of a type cannot be archived.
DELETE /v3/incident_forms/{id} - Destructive
Update Incident Forms V3
Replace an incident form, including its elements and expressions.
PUT /v3/incident_forms/{id}
No operations match.
See How connections work for access and permissions, or browse all integrations.