GET /incidents/{id}/alerts

List alerts for the specified incident.

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

For more information see the API Concepts Document

Scoped OAuth requires: incidents.read

Servers

Path parameters

Name Type Required Description
id String Yes

The ID of the resource.

Request headers

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"

Query parameters

Name Type Required Description
limit Integer No

The number of results per page.

include String No

Array of additional details to include.

Possible values:

  • "incidents"
  • "first_trigger_log_entries"
  • "services"
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.)

Possible values:

  • "triggered"
  • "resolved"
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.

Possible values:

  • "created_at:desc"
  • "resolved_at"
  • "resolved_at:asc"
  • "resolved_at:desc"
  • "created_at:asc"
  • "created_at"
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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.