Skip to content
Talk to an Engineer Dashboard

PagerDuty

Connect to PagerDuty to manage incidents, services, users, teams, escalation policies, schedules, and on-call rotations.

Connect to PagerDuty to manage incidents, services, users, teams, escalation policies, schedules, and on-call rotations.

PagerDuty logo

Supports authentication: OAuth 2.0

List escalation policies in PagerDuty. Supports filtering by query, user, team, and includes.

NameTypeRequiredDescription
includestringNoAdditional resources to include. Options: services, teams, targets.
limitintegerNoThe number of results per page. Maximum 100.
offsetintegerNoOffset to start pagination search results.
querystringNoFilters the results by name.
sort_bystringNoUsed to specify a field to sort the response on. Options: name, name:asc, name:desc.
team_idsstringNoComma-separated list of team IDs to filter escalation policies by.
user_idsstringNoComma-separated list of user IDs to filter escalation policies for.

Create a new escalation policy in PagerDuty. Escalation policies define who gets notified and in what order when an incident is triggered.

NameTypeRequiredDescription
descriptionstringNoA description of the escalation policy.
namestringYesThe name of the escalation policy.
num_loopsintegerNoThe number of times the escalation policy will repeat after reaching the end of its escalation rules.
on_call_handoff_notificationsstringNoDetermines how on call handoff notifications will be sent for users on the escalation policy. Options: if_has_services, always.
rule_escalation_delay_in_minutesintegerNoThe number of minutes before an unacknowledged incident escalates to the next rule.
target_idstringYesThe ID of the user or schedule to notify in the first escalation rule.
target_typestringNoThe type of the first escalation rule target. Options: user_reference, schedule_reference.

Delete a PagerDuty escalation policy. The policy must not be in use by any services or schedules.

NameTypeRequiredDescription
idstringYesThe ID of the escalation policy to delete.

Get details of a specific PagerDuty escalation policy by its ID.

NameTypeRequiredDescription
idstringYesThe ID of the escalation policy to retrieve.
includestringNoAdditional resources to include. Options: services, teams, targets.

Update an existing PagerDuty escalation policy’s name, description, or loop settings.

NameTypeRequiredDescription
descriptionstringNoUpdated description of the escalation policy.
idstringYesThe ID of the escalation policy to update.
namestringNoThe updated name of the escalation policy.
num_loopsintegerNoThe number of times the escalation policy will repeat after reaching the end.
on_call_handoff_notificationsstringNoDetermines how on-call handoff notifications are sent. Options: if_has_services, always.

Create a new incident in PagerDuty. Requires a title, service ID, and the email of the user creating the incident.

NameTypeRequiredDescription
body_detailsstringNoAdditional details about the incident body (plain text).
escalation_policy_idstringNoThe ID of the escalation policy to assign to the incident.
from_emailstringYesThe email address of the user creating the incident. Required by PagerDuty.
incident_keystringNoA string that identifies the incident. Used for deduplication.
priority_idstringNoThe ID of the priority to assign to the incident.
service_idstringYesThe ID of the service the incident belongs to.
titlestringYesA brief description of the incident.
urgencystringNoThe urgency of the incident. Options: high, low.

Get details of a specific PagerDuty incident by its ID, including status, assignments, services, and timeline.

NameTypeRequiredDescription
idstringYesThe ID of the incident to retrieve.

Manage multiple PagerDuty incidents in bulk. Acknowledge, resolve, merge, or reassign multiple incidents at once.

NameTypeRequiredDescription
from_emailstringYesThe email address of the user performing the bulk action. Required by PagerDuty.
incident_idsstringYesComma-separated list of incident IDs to manage.
statusstringYesThe status to apply to all specified incidents. Options: acknowledged, resolved.

Add a note to a PagerDuty incident. Notes are visible to all responders on the incident.

NameTypeRequiredDescription
contentstringYesThe content of the note to add to the incident.
from_emailstringYesThe email address of the user creating the note. Required by PagerDuty.
idstringYesThe ID of the incident to add a note to.

Update an existing PagerDuty incident. Can change status, urgency, title, priority, escalation policy, or reassign it.

NameTypeRequiredDescription
assignee_idstringNoThe ID of the user to assign the incident to.
escalation_policy_idstringNoThe ID of the escalation policy to assign to the incident.
from_emailstringYesThe email address of the user making the update. Required by PagerDuty.
idstringYesThe ID of the incident to update.
priority_idstringNoThe ID of the priority to assign to the incident.
resolutionstringNoThe resolution note for the incident (used when resolving).
statusstringNoThe new status of the incident. Options: acknowledged, resolved.
titlestringNoA brief description of the incident.
urgencystringNoThe urgency of the incident. Options: high, low.

List existing incidents in PagerDuty. Supports filtering by status, urgency, service, team, assigned user, and date range.

NameTypeRequiredDescription
date_rangestringNoWhen set to ‘all’, the since and until parameters and defaults are ignored.
includestringNoArray of additional resources to include. Options: acknowledgers, agents, assignees, conference_bridge, escalation_policies, first_trigger_log_entries, responders, services, teams, users.
limitintegerNoThe number of results to return per page. Maximum 100.
offsetintegerNoOffset to start pagination search results.
service_idsstringNoComma-separated list of service IDs to filter incidents by.
sincestringNoThe start of the date range to search (ISO 8601 format).
sort_bystringNoUsed to specify a field you would like to sort the response on. Options: incident_number, created_at, resolved_at, urgency.
statusesstringNoComma-separated list of statuses to filter by. Options: triggered, acknowledged, resolved.
team_idsstringNoComma-separated list of team IDs to filter incidents by.
untilstringNoThe end of the date range to search (ISO 8601 format).
urgenciesstringNoComma-separated list of urgencies to filter by. Options: high, low.
user_idsstringNoComma-separated list of user IDs to filter incidents assigned to.

List log entries across all incidents in PagerDuty. Log entries record actions taken on incidents including notifications, acknowledgements, and assignments.

NameTypeRequiredDescription
includestringNoAdditional resources to include. Options: incidents, services, channels, teams.
is_overviewbooleanNoIf true, only show log entries of type ‘notify_log_entry’.
limitintegerNoThe number of results per page. Maximum 100.
offsetintegerNoOffset to start pagination search results.
sincestringNoThe start of the date range (ISO 8601).
team_idsstringNoComma-separated list of team IDs to filter log entries by.
time_zonestringNoTime zone for the log entries (IANA format).
untilstringNoThe end of the date range (ISO 8601).

Get details of a specific PagerDuty log entry by its ID.

NameTypeRequiredDescription
idstringYesThe ID of the log entry to retrieve.
includestringNoAdditional resources to include. Options: incidents, services, channels, teams.
time_zonestringNoTime zone for the log entry (IANA format).

Create a new maintenance window in PagerDuty. During a maintenance window, no incidents will be created for the associated services.

NameTypeRequiredDescription
descriptionstringNoA description of the maintenance window.
end_timestringYesThe end time of the maintenance window (ISO 8601 format).
from_emailstringYesThe email address of the user creating the maintenance window. Required by PagerDuty.
service_idsstringYesComma-separated list of service IDs to include in the maintenance window.
start_timestringYesThe start time of the maintenance window (ISO 8601 format).

Delete a PagerDuty maintenance window. Only future and ongoing maintenance windows may be deleted.

NameTypeRequiredDescription
idstringYesThe ID of the maintenance window to delete.

Get details of a specific PagerDuty maintenance window by its ID.

NameTypeRequiredDescription
idstringYesThe ID of the maintenance window to retrieve.
includestringNoAdditional resources to include. Options: services, teams.

Update an existing PagerDuty maintenance window’s description, start time, or end time.

NameTypeRequiredDescription
descriptionstringNoUpdated description of the maintenance window.
end_timestringNoUpdated end time of the maintenance window (ISO 8601 format).
idstringYesThe ID of the maintenance window to update.
start_timestringNoUpdated start time of the maintenance window (ISO 8601 format).

List maintenance windows in PagerDuty. Maintenance windows disable incident notifications for services during scheduled maintenance periods.

NameTypeRequiredDescription
filterstringNoFilter maintenance windows by time. Options: past, future, ongoing.
includestringNoAdditional resources to include. Options: services, teams.
limitintegerNoThe number of results per page. Maximum 100.
offsetintegerNoOffset to start pagination search results.
querystringNoFilters the results by description.
service_idsstringNoComma-separated list of service IDs to filter maintenance windows by.
team_idsstringNoComma-separated list of team IDs to filter maintenance windows by.

List notifications sent for incidents in a given time range. Notifications are messages sent to users when incidents are triggered, acknowledged, or resolved.

NameTypeRequiredDescription
filterstringNoFilters the results by notification type. Options: sms_notification, email_notification, phone_notification, push_notification.
includestringNoAdditional resources to include. Options: users.
limitintegerNoThe number of results per page. Maximum 100.
offsetintegerNoOffset to start pagination search results.
sincestringYesThe start of the date range (ISO 8601). Required.
time_zonestringNoTime zone for the notification data (IANA format).
untilstringYesThe end of the date range (ISO 8601). Required.

List who is on call right now or within a date range. Supports filtering by schedule, escalation policy, and user.

NameTypeRequiredDescription
earliestbooleanNoWhen set to true, returns only the earliest on-call for each combination of escalation policy, escalation level, and user.
escalation_policy_idsstringNoComma-separated list of escalation policy IDs to filter by.
includestringNoAdditional resources to include. Options: users, schedules, escalation_policies.
limitintegerNoThe number of results per page. Maximum 100.
offsetintegerNoOffset to start pagination search results.
schedule_idsstringNoComma-separated list of schedule IDs to filter by.
sincestringNoThe start of the time range to retrieve on-call information (ISO 8601).
time_zonestringNoTime zone for the on-call data (IANA format).
untilstringNoThe end of the time range to retrieve on-call information (ISO 8601).
user_idsstringNoComma-separated list of user IDs to filter on-calls by.

List the priority options available for incidents in PagerDuty. Returns all configured priority levels.

Create a new on-call schedule in PagerDuty with a single layer. Schedules determine who is on call at any given time.

NameTypeRequiredDescription
descriptionstringNoA description of the schedule.
layer_namestringNoThe name of the first schedule layer.
layer_startstringYesThe start time of the schedule layer (ISO 8601 format).
namestringYesThe name of the schedule.
rotation_turn_length_secondsintegerNoThe duration of each on-call rotation turn in seconds (e.g., 86400 = 1 day, 604800 = 1 week).
rotation_virtual_startstringYesThe effective start time of the rotation to align turn order (ISO 8601 format).
time_zonestringYesThe time zone of the schedule (IANA format, e.g., America/New_York).
user_idsstringYesComma-separated list of user IDs to include in the rotation.

Delete a PagerDuty on-call schedule. The schedule must not be associated with any escalation policies.

NameTypeRequiredDescription
idstringYesThe ID of the schedule to delete.

Get details of a specific PagerDuty on-call schedule by its ID, including layers and users.

NameTypeRequiredDescription
idstringYesThe ID of the schedule to retrieve.
sincestringNoThe start of the date range to show schedule entries for (ISO 8601).
time_zonestringNoTime zone of the displayed schedule (IANA format).
untilstringNoThe end of the date range to show schedule entries for (ISO 8601).

Update an existing PagerDuty on-call schedule’s name, description, or time zone.

NameTypeRequiredDescription
descriptionstringNoUpdated description of the schedule.
idstringYesThe ID of the schedule to update.
namestringNoUpdated name of the schedule.
time_zonestringNoUpdated time zone (IANA format, e.g., America/New_York).

List on-call schedules in PagerDuty. Supports filtering by query string and pagination.

NameTypeRequiredDescription
includestringNoAdditional resources to include. Options: schedule_layers, teams, users.
limitintegerNoThe number of results per page. Maximum 100.
offsetintegerNoOffset to start pagination search results.
querystringNoFilters the results by name.

Create a new service in PagerDuty. A service represents something you monitor and manage incidents for.

NameTypeRequiredDescription
acknowledgement_timeoutintegerNoTime in seconds that an incident is automatically re-triggered after being acknowledged. Set to 0 to disable.
alert_creationstringNoWhether a service creates only incidents or creates both incidents and alerts. Options: create_incidents, create_alerts_and_incidents.
auto_resolve_timeoutintegerNoTime in seconds that an incident is automatically resolved if left open. Set to 0 to disable.
descriptionstringNoThe user-provided description of the service.
escalation_policy_idstringYesThe ID of the escalation policy to assign to this service.
namestringYesThe name of the service.

Delete an existing PagerDuty service. This action is irreversible. Only services without open incidents may be deleted.

NameTypeRequiredDescription
idstringYesThe ID of the service to delete.

Get details of a specific PagerDuty service by its ID.

NameTypeRequiredDescription
idstringYesThe ID of the service to retrieve.
includestringNoAdditional resources to include. Options: escalation_policies, teams, integrations.

Update an existing PagerDuty service. Can change name, description, escalation policy, timeouts, and alert creation settings.

NameTypeRequiredDescription
acknowledgement_timeoutintegerNoTime in seconds that an incident is automatically re-triggered after being acknowledged.
alert_creationstringNoWhether a service creates only incidents or also alerts. Options: create_incidents, create_alerts_and_incidents.
auto_resolve_timeoutintegerNoTime in seconds that an incident is automatically resolved if left open.
descriptionstringNoThe user-provided description of the service.
escalation_policy_idstringNoThe ID of the escalation policy to assign to this service.
idstringYesThe ID of the service to update.
namestringNoThe name of the service.
statusstringNoThe current state of the service. Options: active, warning, critical, maintenance, disabled.

List existing services in PagerDuty. Supports filtering by team, query string, and pagination.

NameTypeRequiredDescription
includestringNoAdditional resources to include. Options: escalation_policies, teams, integrations, auto_pause_notifications_parameters.
limitintegerNoThe number of results per page. Maximum 100.
offsetintegerNoOffset to start pagination search results.
querystringNoFilters the results by name.
sort_bystringNoSort results by this field. Options: name, name:asc, name:desc.
team_idsstringNoComma-separated list of team IDs to filter services by.

Create a new team in PagerDuty. Teams allow grouping of users and services.

NameTypeRequiredDescription
descriptionstringNoA description of the team.
namestringYesThe name of the team.

Delete a PagerDuty team. The team must have no associated users, services, or escalation policies before it can be deleted.

NameTypeRequiredDescription
idstringYesThe ID of the team to delete.

Get details of a specific PagerDuty team by its ID.

NameTypeRequiredDescription
idstringYesThe ID of the team to retrieve.

Update an existing PagerDuty team’s name or description.

NameTypeRequiredDescription
descriptionstringNoUpdated description of the team.
idstringYesThe ID of the team to update.
namestringNoThe updated name of the team.

List teams in PagerDuty. Supports filtering by query string and pagination.

NameTypeRequiredDescription
limitintegerNoThe number of results per page. Maximum 100.
offsetintegerNoOffset to start pagination search results.
querystringNoFilters the results by name.

Create a new user in PagerDuty. Requires name, email, and the creating user’s email in the From header.

NameTypeRequiredDescription
colorstringNoThe schedule color for the user.
emailstringYesThe user’s email address.
from_emailstringYesThe email address of the admin creating this user. Required by PagerDuty.
namestringYesThe name of the user.
rolestringNoThe user’s role. Options: admin, limited_user, observer, owner, read_only_user, restricted_access, read_only_limited_user, user.
time_zonestringNoThe time zone of the user (IANA format, e.g., America/New_York).

Delete a PagerDuty user. Users cannot be deleted if they are the only remaining account owner.

NameTypeRequiredDescription
idstringYesThe ID of the user to delete.

Get details of a specific PagerDuty user by their ID.

NameTypeRequiredDescription
idstringYesThe ID of the user to retrieve.
includestringNoAdditional resources to include. Options: contact_methods, notification_rules, teams.

Update an existing PagerDuty user’s profile including name, email, role, time zone, and color.

NameTypeRequiredDescription
colorstringNoThe schedule color for the user.
emailstringNoThe user’s updated email address.
idstringYesThe ID of the user to update.
namestringNoThe updated name of the user.
rolestringNoThe user’s role. Options: admin, limited_user, observer, owner, read_only_user, restricted_access, read_only_limited_user, user.
time_zonestringNoThe time zone of the user (IANA format, e.g., America/New_York).

List users in PagerDuty. Supports filtering by query, team, and includes.

NameTypeRequiredDescription
includestringNoAdditional resources to include. Options: contact_methods, notification_rules, teams.
limitintegerNoThe number of results per page. Maximum 100.
offsetintegerNoOffset to start pagination search results.
querystringNoFilters the results by name.
team_idsstringNoComma-separated list of team IDs to filter users by.

List available PagerDuty vendors (integration types). Vendors represent the services or monitoring tools that can be integrated with PagerDuty.

NameTypeRequiredDescription
limitintegerNoThe number of results per page. Maximum 100.
offsetintegerNoOffset to start pagination search results.
querystringNoFilters the results by vendor name.