Skip to main content
incident.io logo

Overview

Add incident.io to any ModuleX agent or workflow. Incident management and on-call response against the incident.io REST API (api.incident.io). Manage incidents, actions, follow-ups, workflows, schedules, escalations, escalation paths, custom fields, incident roles, and reference data.
Categories: Monitoring & Observability · Incident Management · On Call · Auth: API Key · Actions: 46

Authentication

API Key Authentication

Authenticate using your incident.io API key
1

Step 1

Log in to your incident.io dashboard
2

Step 2

Go to Settings -> API keys
3

Step 3

Create a new API key and select the permissions it should have
4

Step 4

Copy the key (it is shown only once) and paste it below

Required Credentials

FieldDescriptionRequiredFormat
incident.io API KeyYour incident.io API key from Settings -> API keysYes-

Available Actions

Parameters

page_size
integer
Number of results to return per page (e.g., 10, 25, 50)
after
string
Pagination cursor to fetch the next page of results
sort_by
string
Sort order: ‘created_at_newest_first’ or ‘created_at_oldest_first’
filter_mode
string
How to combine filters: ‘all’ or ‘any’

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "incidents": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Incidents",
      "type": "array"
    },
    "pagination_meta": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Pagination Meta"
    }
  },
  "required": [
    "success"
  ],
  "title": "IncidentsListOutput",
  "type": "object"
}

Parameters

idempotency_key
string
required
Unique identifier to prevent duplicate creation (e.g., a UUID)
severity_id
string
required
ID of the severity level
visibility
string
required
Visibility of the incident: ‘public’ or ‘private’
name
string
Name of the incident
summary
string
Brief summary of the incident
incident_type_id
string
ID of the incident type
incident_status_id
string
ID of the initial incident status

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "incident": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Incident"
    }
  },
  "required": [
    "success"
  ],
  "title": "IncidentsCreateOutput",
  "type": "object"
}

Parameters

id
string
required
ID of the incident to retrieve

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "incident": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Incident"
    }
  },
  "required": [
    "success"
  ],
  "title": "IncidentsShowOutput",
  "type": "object"
}

Parameters

id
string
required
ID of the incident to update
notify_incident_channel
boolean
required
Whether to notify the incident channel about this update
name
string
Updated name of the incident
summary
string
Updated summary of the incident
severity_id
string
Updated severity ID
incident_status_id
string
Updated status ID
incident_type_id
string
Updated incident type ID

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "incident": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Incident"
    }
  },
  "required": [
    "success"
  ],
  "title": "IncidentsUpdateOutput",
  "type": "object"
}

Parameters

incident_id
string
Filter actions by incident ID
incident_mode
string
Filter by incident mode: standard, retrospective, test, tutorial, or stream

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "actions": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Actions",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ActionsListOutput",
  "type": "object"
}

Parameters

id
string
required
Action ID

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "action": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Action"
    }
  },
  "required": [
    "success"
  ],
  "title": "ActionsShowOutput",
  "type": "object"
}

Parameters

incident_id
string
Filter follow-ups by incident ID
incident_mode
string
Filter by incident mode: standard, retrospective, test, tutorial, or stream

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "follow_ups": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Follow Ups",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "FollowUpsListOutput",
  "type": "object"
}

Parameters

id
string
required
Follow-up ID

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "follow_up": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Follow Up"
    }
  },
  "required": [
    "success"
  ],
  "title": "FollowUpsShowOutput",
  "type": "object"
}

Parameters

page_size
integer
Number of results to return per page (e.g., 10, 25, 50)
after
string
Pagination cursor to fetch the next page of results
email
string
Filter users by email address
slack_user_id
string
Filter users by Slack user ID

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "users": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Users",
      "type": "array"
    },
    "pagination_meta": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Pagination Meta"
    }
  },
  "required": [
    "success"
  ],
  "title": "UsersListOutput",
  "type": "object"
}

Parameters

id
string
required
The unique identifier of the user to retrieve

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "user": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "User"
    }
  },
  "required": [
    "success"
  ],
  "title": "UsersShowOutput",
  "type": "object"
}

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "workflows": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Workflows",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "WorkflowsListOutput",
  "type": "object"
}

Parameters

name
string
required
Name of the workflow
folder
string
Folder to organize the workflow in
state
string
State of the workflow: active, draft, or disabled (Default: draft)
trigger
string
Trigger type for the workflow (Default: incident.updated)
steps
array
Array of workflow steps (defaults to [])
condition_groups
array
Array of condition groups controlling when the workflow runs
runs_on_incidents
string
When to run: newly_created, newly_created_and_active, active, or all (Default: newly_created)
runs_on_incident_modes
array
Array of incident modes to run on (defaults to [‘standard’])
include_private_incidents
boolean
Whether to include private incidents (Default: true)
continue_on_step_error
boolean
Whether to continue executing subsequent steps if one fails (Default: false)
once_for
array
Array of fields making the workflow run once per combination
expressions
array
Array of workflow expressions for advanced logic
delay
object
Delay configuration object

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "workflow": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Workflow"
    },
    "management_meta": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Management Meta"
    }
  },
  "required": [
    "success"
  ],
  "title": "WorkflowsCreateOutput",
  "type": "object"
}

Parameters

id
string
required
The ID of the workflow to retrieve
skip_step_upgrades
boolean
Skip workflow step upgrades when existing step parameters changed

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "workflow": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Workflow"
    },
    "management_meta": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Management Meta"
    }
  },
  "required": [
    "success"
  ],
  "title": "WorkflowsShowOutput",
  "type": "object"
}

Parameters

id
string
required
The ID of the workflow to update
name
string
required
New name for the workflow
steps
array
required
Complete array of workflow steps
condition_groups
array
required
Complete array of workflow condition groups
runs_on_incidents
string
required
When to run: newly_created, newly_created_and_active, active, or all
runs_on_incident_modes
array
required
Complete array of incident modes to run on
include_private_incidents
boolean
required
Whether to include private incidents
continue_on_step_error
boolean
required
Whether to continue executing subsequent steps if one fails
once_for
array
required
Complete array of fields that make the workflow run once
expressions
array
required
Complete array of workflow expressions
state
string
New state: active, draft, or disabled
folder
string
New folder for the workflow
delay
object
Delay configuration object

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "workflow": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Workflow"
    },
    "management_meta": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Management Meta"
    }
  },
  "required": [
    "success"
  ],
  "title": "WorkflowsUpdateOutput",
  "type": "object"
}

Parameters

id
string
required
The ID of the workflow to delete

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Message"
    }
  },
  "required": [
    "success"
  ],
  "title": "WorkflowsDeleteOutput",
  "type": "object"
}

Parameters

page_size
integer
Number of results to return per page (e.g., 10, 25, 50)
after
string
Pagination cursor to fetch the next page of results

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "schedules": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Schedules",
      "type": "array"
    },
    "pagination_meta": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Pagination Meta"
    }
  },
  "required": [
    "success"
  ],
  "title": "SchedulesListOutput",
  "type": "object"
}

Parameters

name
string
required
Name of the schedule
timezone
string
required
Timezone for the schedule (e.g., America/New_York)
rotations_config
object
required
Schedule configuration object with rotations

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "schedule": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Schedule"
    }
  },
  "required": [
    "success"
  ],
  "title": "SchedulesCreateOutput",
  "type": "object"
}

Parameters

id
string
required
The ID of the schedule

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "schedule": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Schedule"
    }
  },
  "required": [
    "success"
  ],
  "title": "SchedulesShowOutput",
  "type": "object"
}

Parameters

id
string
required
The ID of the schedule to update
name
string
New name for the schedule
timezone
string
New timezone for the schedule
rotations_config
object
Schedule configuration object with rotations

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "schedule": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Schedule"
    }
  },
  "required": [
    "success"
  ],
  "title": "SchedulesUpdateOutput",
  "type": "object"
}

Parameters

id
string
required
The ID of the schedule to delete

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Message"
    }
  },
  "required": [
    "success"
  ],
  "title": "SchedulesDeleteOutput",
  "type": "object"
}

Parameters

page_size
integer
Number of results to return per page (e.g., 10, 25, 50)
after
string
Pagination cursor to fetch the next page of results

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "escalations": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Escalations",
      "type": "array"
    },
    "pagination_meta": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Pagination Meta"
    }
  },
  "required": [
    "success"
  ],
  "title": "EscalationsListOutput",
  "type": "object"
}

Parameters

idempotency_key
string
required
Unique identifier to prevent duplicate escalation creation
title
string
required
Title of the escalation
escalation_path_id
string
ID of the escalation path (required if user_ids not provided)
user_ids
string
Comma-separated user IDs to notify (required if no escalation_path_id)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "escalation": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Escalation"
    }
  },
  "required": [
    "success"
  ],
  "title": "EscalationsCreateOutput",
  "type": "object"
}

Parameters

id
string
required
The ID of the escalation policy

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "escalation": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Escalation"
    }
  },
  "required": [
    "success"
  ],
  "title": "EscalationsShowOutput",
  "type": "object"
}

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "custom_fields": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Custom Fields",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "CustomFieldsListOutput",
  "type": "object"
}

Parameters

name
string
required
Name of the custom field
description
string
required
Description of the custom field
field_type
string
required
Field type: text, single_select, multi_select, numeric, link, etc.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "custom_field": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Custom Field"
    }
  },
  "required": [
    "success"
  ],
  "title": "CustomFieldsCreateOutput",
  "type": "object"
}

Parameters

id
string
required
Custom field ID

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "custom_field": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Custom Field"
    }
  },
  "required": [
    "success"
  ],
  "title": "CustomFieldsShowOutput",
  "type": "object"
}

Parameters

id
string
required
Custom field ID
name
string
required
New name for the custom field
description
string
required
New description for the custom field

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "custom_field": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Custom Field"
    }
  },
  "required": [
    "success"
  ],
  "title": "CustomFieldsUpdateOutput",
  "type": "object"
}

Parameters

id
string
required
Custom field ID

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Message"
    }
  },
  "required": [
    "success"
  ],
  "title": "CustomFieldsDeleteOutput",
  "type": "object"
}

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "severities": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Severities",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "SeveritiesListOutput",
  "type": "object"
}

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "incident_statuses": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Incident Statuses",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "IncidentStatusesListOutput",
  "type": "object"
}

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "incident_types": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Incident Types",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "IncidentTypesListOutput",
  "type": "object"
}

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "incident_roles": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Incident Roles",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "IncidentRolesListOutput",
  "type": "object"
}

Parameters

name
string
required
Name of the incident role
description
string
required
Description of the incident role
instructions
string
required
Instructions for the incident role
shortform
string
required
Short form abbreviation for the role

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "incident_role": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Incident Role"
    }
  },
  "required": [
    "success"
  ],
  "title": "IncidentRolesCreateOutput",
  "type": "object"
}

Parameters

id
string
required
The ID of the incident role

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "incident_role": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Incident Role"
    }
  },
  "required": [
    "success"
  ],
  "title": "IncidentRolesShowOutput",
  "type": "object"
}

Parameters

id
string
required
The ID of the incident role to update
name
string
required
Name of the incident role
description
string
required
Description of the incident role
instructions
string
required
Instructions for the incident role
shortform
string
required
Short form abbreviation for the role

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "incident_role": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Incident Role"
    }
  },
  "required": [
    "success"
  ],
  "title": "IncidentRolesUpdateOutput",
  "type": "object"
}

Parameters

id
string
required
The ID of the incident role to delete

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Message"
    }
  },
  "required": [
    "success"
  ],
  "title": "IncidentRolesDeleteOutput",
  "type": "object"
}

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "incident_timestamps": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Incident Timestamps",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "IncidentTimestampsListOutput",
  "type": "object"
}

Parameters

id
string
required
The ID of the incident timestamp

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "incident_timestamp": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Incident Timestamp"
    }
  },
  "required": [
    "success"
  ],
  "title": "IncidentTimestampsShowOutput",
  "type": "object"
}

Parameters

incident_id
string
The ID of the incident to get updates for
page_size
integer
Number of results to return per page (e.g., 10, 25, 50)
after
string
Pagination cursor to fetch the next page of results

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "incident_updates": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Incident Updates",
      "type": "array"
    },
    "pagination_meta": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Pagination Meta"
    }
  },
  "required": [
    "success"
  ],
  "title": "IncidentUpdatesListOutput",
  "type": "object"
}

Parameters

schedule_id
string
required
The ID of the schedule to get entries for
entry_window_start
string
Start of the filter window in ISO 8601 format
entry_window_end
string
End of the filter window in ISO 8601 format

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "schedule_entries": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Schedule Entries"
    },
    "pagination_meta": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Pagination Meta"
    }
  },
  "required": [
    "success"
  ],
  "title": "ScheduleEntriesListOutput",
  "type": "object"
}

Parameters

rotation_id
string
required
The ID of the rotation to override
layer_id
string
required
The ID of the layer this override applies to
schedule_id
string
required
The ID of the schedule
start_at
string
required
When the override starts in ISO 8601 format
end_at
string
required
When the override ends in ISO 8601 format
user_id
string
The ID of the user to assign
user_email
string
The email of the user to assign
user_slack_id
string
The Slack ID of the user to assign

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "override": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Override"
    }
  },
  "required": [
    "success"
  ],
  "title": "ScheduleOverridesCreateOutput",
  "type": "object"
}

Parameters

page_size
integer
Number of results to return per page (e.g., 10, 25, 50)
after
string
Pagination cursor to fetch the next page of results

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "escalation_paths": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Escalation Paths",
      "type": "array"
    },
    "pagination_meta": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Pagination Meta"
    }
  },
  "required": [
    "success"
  ],
  "title": "EscalationPathsListOutput",
  "type": "object"
}

Parameters

name
string
required
Name of the escalation path
path
array
required
Array of escalation levels. Each level has targets (array of {id, type, schedule_id?, user_id?, urgency}) and time_to_ack_seconds
working_hours
array
Optional working hours config: array of {weekday, start_time, end_time}

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "escalation_path": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Escalation Path"
    }
  },
  "required": [
    "success"
  ],
  "title": "EscalationPathsCreateOutput",
  "type": "object"
}

Parameters

id
string
required
The ID of the escalation path

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "escalation_path": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Escalation Path"
    }
  },
  "required": [
    "success"
  ],
  "title": "EscalationPathsShowOutput",
  "type": "object"
}

Parameters

id
string
required
The ID of the escalation path to update
name
string
required
New name for the escalation path
path
array
required
New escalation path: array of levels with targets and time_to_ack_seconds
working_hours
array
New working hours config: array of {weekday, start_time, end_time}

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "escalation_path": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Escalation Path"
    }
  },
  "required": [
    "success"
  ],
  "title": "EscalationPathsUpdateOutput",
  "type": "object"
}

Parameters

id
string
required
The ID of the escalation path to delete

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Message"
    }
  },
  "required": [
    "success"
  ],
  "title": "EscalationPathsDeleteOutput",
  "type": "object"
}

Limits & Quotas

  • Rate limit: 1200 requests/minute per API key (default).
  • Endpoints: most resources live under /v2; severities, incident statuses, and incident types are served under /v1.
  • Pagination: list endpoints accept page_size plus an after cursor; the tools expose both as optional parameters and do not auto-loop — pass the returned cursor to fetch the next page.
  • Error model: non-2xx responses and timeouts are caught and returned as success=False + error rather than raising. Plan retries on the agent side based on the error string.

CrowdStrike

Datadog

Grafana