Skip to main content
Server path: /pagerduty-incidents | Type: Application | PCID required: Yes

Tools


pagerduty_incidents_create_incident

Create an Incident Parameters:
ParameterTypeRequiredDefaultDescription
incidentobjectYesDetails of the incident to be created.

pagerduty_incidents_create_incident_note

Create a note on an incident Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
noteobjectYesThe note value

pagerduty_incidents_create_incident_responder_request

Create a responder request for an incident Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
messagestringYesThe message sent with the responder request.
requester_idstringYesThe user id of the requester.
responder_request_targetsobjectYesThe array of targets the responder request is sent to.

pagerduty_incidents_create_incident_snooze

Snooze an incident Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
durationintegerYesThe 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:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
html_messagestringNoThe html content to be sent for the custom html email status update. Required if sending custom html email.
messagestringYesThe message to be posted as a status update.
subjectstringNoThe 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:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
incident_workflow_instanceobjectYesIncident Workflow Instance

pagerduty_incidents_get_incident

Get an incident Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
includestringNoArray of additional details to include.

pagerduty_incidents_get_incident_alert

Get an alert Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
alert_idstringYesThe id of the alert to retrieve.

pagerduty_incidents_get_incident_workflow

Get an Incident Workflow Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.

pagerduty_incidents_get_log_entry

Get a log entry Parameters:
ParameterTypeRequiredDefaultDescription
time_zonestringNoTime zone in which results will be rendered. This will default to the account time zone.
idstringYesThe ID of the resource.
includestringNoArray of additional Models to include in response.

pagerduty_incidents_get_outlier_incident

Get Outlier Incident Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
sincestringNoThe start of the date range over which you want to search.
additional_detailsstringNoArray of additional attributes to any of the returned incidents for related incidents.

pagerduty_incidents_get_past_incidents

Get Past Incidents Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
limitintegerNoThe number of results to be returned in the response.
totalbooleanNoBy 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.

Get Related Incidents Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
additional_detailsstringNoArray of additional attributes to any of the returned incidents for related incidents.

pagerduty_incidents_list_incident_alerts

List alerts for an incident Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe number of results per page.
offsetintegerNoOffset to start pagination search results.
totalbooleanNoBy 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.
idstringYesThe ID of the resource.
alert_keystringNoAlert de-duplication key.
statusesstringNoReturn only alerts with the given statuses. (More status codes may be introduced in the future.)
sort_bystringNoUsed 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.
includestringNoArray of additional details to include.

pagerduty_incidents_list_incident_notes

List notes for an incident Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.

pagerduty_incidents_list_incident_workflows

List Incident Workflows Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe number of results per page.
offsetintegerNoOffset to start pagination search results.
totalbooleanNoBy 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.
querystringNoFilters the result, showing only the records whose name matches the query.
includestringNoArray of additional details to include.

pagerduty_incidents_list_incidents

List incidents Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe number of results per page. Maximum of 100.
offsetintegerNoOffset to start pagination search results.
totalbooleanNoBy 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_rangestringNoWhen set to all, the since and until parameters and defaults are ignored.
incident_keystringNoIncident 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_idsstring[]NoReturns only the incidents associated with the passed service(s). This expects one or more service IDs.
team_idsstring[]NoAn array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.
user_idsstring[]NoReturns 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.
urgenciesstringNoArray of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the urgencies ability to do this.
time_zonestringNoTime zone in which results will be rendered. This will default to the account time zone.
statusesstringNoReturn 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_bystring[]NoUsed 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.
includestringNoArray of additional details to include.
sincestringNoThe start of the date range over which you want to search. Maximum range is 6 months and default is 1 month.
untilstringNoThe 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:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe number of results per page.
offsetintegerNoOffset to start pagination search results.
totalbooleanNoBy 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_zonestringNoTime zone in which results will be rendered. This will default to the account time zone.
sincestringNoThe start of the date range over which you want to search.
untilstringNoThe end of the date range over which you want to search.
is_overviewbooleanNoIf true, will return a subset of log entries that show only the most important changes to the incident.
includestringNoArray of additional Models to include in response.
team_idsstring[]NoAn 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:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
source_incidentsany[]YesThe source incidents that will be merged into the target incident and resolved.

pagerduty_incidents_update_incident

Update an incident Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
incidentobjectYesThe parameters of the incident to update.

pagerduty_incidents_update_incident_alert

Update an alert Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
alert_idstringYesThe id of the alert to retrieve.
alertobjectYesThe alert value

pagerduty_incidents_update_incidents

Manage incidents Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe number of results per page.
offsetintegerNoOffset to start pagination search results.
totalbooleanNoBy 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.
incidentsany[]YesAn array of incidents, including the parameters to update.