Manage 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.

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Query Parameters

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.

Defaultfalse

Header Parameters

Accept*string

The Accept header is used as a versioning header.

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

Content-Type*"application/json"

Default"application/json"

Value in

"application/json"

From*string

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

Formatemail

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

incidents*array<unknown>

An array of incidents, including the parameters to update.

Response Body

`application/json`

curl -X PUT "https://example.com/incidents" \  -H "Accept: application/vnd.pagerduty+json;version=2" \  -H "Content-Type: application/json" \  -H "From: user@example.com" \  -H "Content-Type: application/json" \  -d '{    "incidents": [      {        "id": "PT4KHLK",        "type": "incident_reference",        "status": "acknowledged"      },      {        "id": "PQMF62U",        "type": "incident_reference",        "priority": {          "id": "P53ZZH5",          "type": "priority_reference"        }      },      {        "id": "PPVZH9X",        "type": "incident_reference",        "status": "resolved"      },      {        "id": "P8JOGX7",        "type": "incident_reference",        "assignments": [          {            "assignee": {              "id": "PXPGF42",              "type": "user_reference"            }          }        ]      },      {        "id": "PYJ9K7I",        "type": "incident_reference",        "incident_type": {          "name": "major_incident"        }      }    ]  }'

{  "incidents": [    {      "id": "PT4KHLK",      "type": "incident",      "summary": "[#1234] The server is on fire.",      "self": "https://api.pagerduty.com/incidents/PT4KHLK",      "html_url": "https://subdomain.pagerduty.com/incidents/PT4KHLK",      "incident_number": 1234,      "created_at": "2015-10-06T21:30:42Z",      "updated_at": "2015-10-06T21:40:23Z",      "status": "resolved",      "title": "The server is on fire.",      "alert_counts": {        "all": 2,        "triggered": 0,        "resolved": 2      },      "pending_actions": [        {          "type": "unacknowledge",          "at": "2015-11-10T01:02:52Z"        },        {          "type": "resolve",          "at": "2015-11-10T04:31:52Z"        }      ],      "incident_key": "baf7cf21b1da41b4b0221008339ff357",      "service": {        "id": "PIJ90N7",        "type": "service_reference",        "summary": "My Mail Service",        "self": "https://api.pagerduty.com/services/PIJ90N7",        "html_url": "https://subdomain.pagerduty.com/service-directory/PIJ90N7"      },      "assigned_via": "escalation_policy",      "assignments": [        {          "at": "2015-11-10T00:31:52Z",          "assignee": {            "id": "PXPGF42",            "type": "user_reference",            "summary": "Earline Greenholt",            "self": "https://api.pagerduty.com/users/PXPGF42",            "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"          }        }      ],      "acknowledgements": [        {          "at": "2015-11-10T00:32:52Z",          "acknowledger": {            "id": "PXPGF42",            "type": "user_reference",            "summary": "Earline Greenholt",            "self": "https://api.pagerduty.com/users/PXPGF42",            "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"          }        }      ],      "resolved_at": "2015-10-06T21:38:23Z",      "last_status_change_at": "2015-10-06T21:38:23Z",      "last_status_change_by": {        "id": "PXPGF42",        "type": "user_reference",        "summary": "Earline Greenholt",        "self": "https://api.pagerduty.com/users/PXPGF42",        "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"      },      "first_trigger_log_entry": {        "id": "Q02JTSNZWHSEKV",        "type": "trigger_log_entry_reference",        "summary": "Triggered through the API",        "self": "https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK",        "html_url": "https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV"      },      "incident_type": {        "name": "major_incident"      },      "escalation_policy": {        "id": "PT20YPA",        "type": "escalation_policy_reference",        "summary": "Another Escalation Policy",        "self": "https://api.pagerduty.com/escalation_policies/PT20YPA",        "html_url": "https://subdomain.pagerduty.com/escalation_policies/PT20YPA"      },      "teams": [        {          "id": "PQ9K7I8",          "type": "team_reference",          "summary": "Engineering",          "self": "https://api.pagerduty.com/teams/PQ9K7I8",          "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"        }      ],      "urgency": "high"    }  ]}

Manage incidents

Authorization

Query Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

413application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`