PUT /incidents

Acknowledge, resolve, escalate or reassign one or more incidents.

An incident represents a problem or an issue that needs to be addressed and resolved.

A maximum of 250 incidents may be updated at a time. If more than this number of incidents are given, the API will respond with status 413 (Request Entity Too Large).

For more information see the API Concepts Document

Scoped OAuth requires: incidents.write

This API operation has operation specific rate limits. See the Rate Limits page for more information.

Servers

https://api.pagerduty.com

Request headers

Name Type Required Description

Name	Type	Required	Description
`Accept`	String	Yes	The `Accept` header is used as a versioning header. Default value: "application/vnd.pagerduty+json;version=2"
`Content-Type`	String	Yes	Possible values: `"application/json"` Default value: "application/json"
`From`	String	Yes	The email address of a valid user associated with the account making the request.

Accept

String

Yes

The Accept header is used as a versioning header.

Default value: "application/vnd.pagerduty+json;version=2"

Content-Type

String

Yes

Possible values:

"application/json"

Default value: "application/json"

From

String

Yes

The email address of a valid user associated with the account making the request.

Query parameters

Name Type Required Description

Name	Type	Required	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. Default value: false

limit

Integer

The number of results per page.

offset

Integer

Offset to start pagination search results.

total

Boolean

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.

Default value: false

Request body fields

Name	Type	Required	Description
`incidents[]`	Array	Yes	An array of incidents, including the parameters to update.
`incidents[].id`	String	Yes	The id of the incident to update.
`incidents[].resolution`	String	No	The resolution for this incident. This field is used only when setting the incident status to resolved. The value provided here is added to the incident’s 'Resolve' log entry as a note and will not be displayed directly in the UI.
`incidents[].priority`		No
`incidents[].escalation_policy`		No
`incidents[].urgency`	String	No	The urgency of the incident. Possible values: `"high"` `"low"`
`incidents[].escalation_level`	Integer	No	Escalate the incident to this level in the escalation policy.
`incidents[].type`	String	Yes	The incident type. Possible values: `"incident_reference"` `"incident"`
`incidents[].title`	String	No	A succinct description of the nature, symptoms, cause, or effect of the incident.
`incidents[].status`	String	No	The new status of the incident. Possible values: `"resolved"` `"acknowledged"`
`incidents[].incident_type`		No
`incidents[].conference_bridge`		No
`incidents[].assignments[]`	Array	No	Assign the incident to these assignees.
`incidents[].assignments[].assignee`		No

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.