/pagerduty-incidents | Type: Application | PCID required: Yes
Tools
pagerduty_incidents_create_incident
Create an Incident Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
incident | object | Yes | — | Details of the incident to be created. |
pagerduty_incidents_create_incident_note
Create a note on an incident Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the resource. |
note | object | Yes | — | The note value |
pagerduty_incidents_create_incident_responder_request
Create a responder request for an incident Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the resource. |
message | string | Yes | — | The message sent with the responder request. |
requester_id | string | Yes | — | The user id of the requester. |
responder_request_targets | object | Yes | — | The array of targets the responder request is sent to. |
pagerduty_incidents_create_incident_snooze
Snooze an incident Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the resource. |
duration | integer | Yes | — | The number of seconds to snooze the incident for. After this number of seconds has elapsed, the incident will return to the “triggered” state. |
pagerduty_incidents_create_incident_status_update
Create a status update on an incident Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the resource. |
html_message | string | No | — | The html content to be sent for the custom html email status update. Required if sending custom html email. |
message | string | Yes | — | The message to be posted as a status update. |
subject | string | No | — | The subject to be sent for the custom html email status update. Required if sending custom html email. |
pagerduty_incidents_create_incident_workflow_instance
Start an Incident Workflow Instance Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the resource. |
incident_workflow_instance | object | Yes | — | Incident Workflow Instance |
pagerduty_incidents_get_incident
Get an incident Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the resource. |
include | string | No | — | Array of additional details to include. |
pagerduty_incidents_get_incident_alert
Get an alert Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the resource. |
alert_id | string | Yes | — | The id of the alert to retrieve. |
pagerduty_incidents_get_incident_workflow
Get an Incident Workflow Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the resource. |
pagerduty_incidents_get_log_entry
Get a log entry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
time_zone | string | No | — | Time zone in which results will be rendered. This will default to the account time zone. |
id | string | Yes | — | The ID of the resource. |
include | string | No | — | Array of additional Models to include in response. |
pagerduty_incidents_get_outlier_incident
Get Outlier Incident Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the resource. |
since | string | No | — | The start of the date range over which you want to search. |
additional_details | string | No | — | Array of additional attributes to any of the returned incidents for related incidents. |
pagerduty_incidents_get_past_incidents
Get Past Incidents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the resource. |
limit | integer | No | — | The number of results to be returned in the response. |
total | boolean | No | — | By default the total field in the response body is set to null to provide the fastest possible response times. Set total to true for this field to be populated with the total number of Past Incidents. |
pagerduty_incidents_get_related_incidents
Get Related Incidents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the resource. |
additional_details | string | No | — | Array of additional attributes to any of the returned incidents for related incidents. |
pagerduty_incidents_list_incident_alerts
List alerts for an incident Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | The number of results per page. |
offset | integer | No | — | Offset to start pagination search results. |
total | boolean | No | — | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our Pagination Docs for more information. |
id | string | Yes | — | The ID of the resource. |
alert_key | string | No | — | Alert de-duplication key. |
statuses | string | No | — | Return only alerts with the given statuses. (More status codes may be introduced in the future.) |
sort_by | string | No | — | Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. |
include | string | No | — | Array of additional details to include. |
pagerduty_incidents_list_incident_notes
List notes for an incident Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the resource. |
pagerduty_incidents_list_incident_workflows
List Incident Workflows Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | The number of results per page. |
offset | integer | No | — | Offset to start pagination search results. |
total | boolean | No | — | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our Pagination Docs for more information. |
query | string | No | — | Filters the result, showing only the records whose name matches the query. |
include | string | No | — | Array of additional details to include. |
pagerduty_incidents_list_incidents
List incidents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | The number of results per page. Maximum of 100. |
offset | integer | No | — | Offset to start pagination search results. |
total | boolean | No | — | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our Pagination Docs for more information. |
date_range | string | No | — | When set to all, the since and until parameters and defaults are ignored. |
incident_key | string | No | — | Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. |
service_ids | string[] | No | — | Returns only the incidents associated with the passed service(s). This expects one or more service IDs. |
team_ids | string[] | No | — | An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter. |
user_ids | string[] | No | — | Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user. |
urgencies | string | No | — | Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the urgencies ability to do this. |
time_zone | string | No | — | Time zone in which results will be rendered. This will default to the account time zone. |
statuses | string | No | — | Return only incidents with the given statuses. To query multiple statuses, pass statuses[] more than once, for example: https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged. (More status codes may be introduced in the future.) |
sort_by | string[] | No | — | Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the urgencies ability to sort by the urgency. |
include | string | No | — | Array of additional details to include. |
since | string | No | — | The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. |
until | string | No | — | The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. |
pagerduty_incidents_list_log_entries
List log entries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | The number of results per page. |
offset | integer | No | — | Offset to start pagination search results. |
total | boolean | No | — | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our Pagination Docs for more information. |
time_zone | string | No | — | Time zone in which results will be rendered. This will default to the account time zone. |
since | string | No | — | The start of the date range over which you want to search. |
until | string | No | — | The end of the date range over which you want to search. |
is_overview | boolean | No | — | If true, will return a subset of log entries that show only the most important changes to the incident. |
include | string | No | — | Array of additional Models to include in response. |
team_ids | string[] | No | — | An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter. |
pagerduty_incidents_merge_incidents
Merge incidents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the resource. |
source_incidents | any[] | Yes | — | The source incidents that will be merged into the target incident and resolved. |
pagerduty_incidents_update_incident
Update an incident Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the resource. |
incident | object | Yes | — | The parameters of the incident to update. |
pagerduty_incidents_update_incident_alert
Update an alert Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the resource. |
alert_id | string | Yes | — | The id of the alert to retrieve. |
alert | object | Yes | — | The alert value |
pagerduty_incidents_update_incidents
Manage incidents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | The number of results per page. |
offset | integer | No | — | Offset to start pagination search results. |
total | boolean | No | — | By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our Pagination Docs for more information. |
incidents | any[] | Yes | — | An array of incidents, including the parameters to update. |

