Skip to content
Scalekit Docs
Talk to an EngineerDashboard

PagerDuty connector

OAuth 2.0Developer ToolsMonitoring

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

PagerDuty connector

  1. Terminal window
    npm install @scalekit-sdk/node

    Full SDK reference: Node.js | Python

  2. Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. quickstart.ts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENV_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'pagerduty'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize PagerDuty:', link)
    process.stdout.write('Press Enter after authorizing...')
    await new Promise(r => process.stdin.once('data', r))
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'pagerduty_abilities_list',
    toolInput: {},
    })
    console.log(result)

Connect this agent connector to let your agent:

  • Get vendor, user me, incident alert — Get details of a specific PagerDuty vendor (integration type) by its ID
  • Remove team user, team escalation policy — Remove a user from a PagerDuty team
  • Add team user, team escalation policy — Add a user to a PagerDuty team with a given role
  • List team members, tags, schedule users — List the members of a PagerDuty team
  • Create tag, schedule override, incident responder request — Create a new tag, which can then be assigned to escalation policies, teams, or users to filter and group them
  • Delete schedule override, user, schedule — Delete an on-call override from a PagerDuty schedule

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

pagerduty_abilities_list#List the account's enabled feature abilities (plan and entitlement flags). Useful for an agent to check whether a feature is available before calling a gated endpoint.0 params

List the account's enabled feature abilities (plan and entitlement flags). Useful for an agent to check whether a feature is available before calling a gated endpoint.

pagerduty_audit_records_list#List audit trail records — who did what, when — filterable by actor, action, root resource type, and time range. Defaults to the past 24 hours if no date range is given; the range cannot span more than 31 days.10 params

List audit trail records — who did what, when — filterable by actor, action, root resource type, and time range. Defaults to the past 24 hours if no date range is given; the range cannot span more than 31 days.

NameTypeRequiredDescription
actionsstringoptionalComma-separated list of actions to filter by. Options: create, update, delete.
actor_idstringoptionalOnly return records whose actor has this ID. Must be qualified by also providing actor_type.
actor_typestringoptionalOnly return records whose actor is of this type.
cursorstringoptionalPagination cursor. Provide the next_cursor value from a previous response to fetch the next page.
limitintegeroptionalThe maximum number of records to return.
method_truncated_tokenstringoptionalOnly return records whose method has this truncated token. Must be qualified by also providing method_type.
method_typestringoptionalOnly return records performed via this method.
root_resource_typesstringoptionalComma-separated list of resource types to filter by. Options: users, teams, schedules, escalation_policies, services, ip_allow_lists.
sincestringoptionalThe start of the date range to search. Defaults to now() - 24 hours if omitted.
untilstringoptionalThe end of the date range to search. Defaults to now() if omitted. May not be more than 31 days after since.
pagerduty_business_service_create#Create a new business service — a capability or product that spans multiple technical services, optionally owned by a team.4 params

Create a new business service — a capability or product that spans multiple technical services, optionally owned by a team.

NameTypeRequiredDescription
namestringrequiredThe name of the business service.
descriptionstringoptionalThe description of the business service.
point_of_contactstringoptionalThe owner of the business service.
team_idstringoptionalThe ID of the team that owns this business service.
pagerduty_business_services_list#List business services — capabilities or products that span multiple technical services and are owned by teams — with standard offset pagination.3 params

List business services — capabilities or products that span multiple technical services and are owned by teams — with standard offset pagination.

NameTypeRequiredDescription
limitintegeroptionalThe number of results to return per page.
offsetintegeroptionalOffset to start pagination search results.
totalbooleanoptionalSet to true to populate the total field in the pagination response, at the cost of slower response times.
pagerduty_change_events_list#List change events (deploys, config changes, and other events sent via the Change Events API) so they can be correlated in time with incidents. Filterable by team, integration, and date range.7 params

List change events (deploys, config changes, and other events sent via the Change Events API) so they can be correlated in time with incidents. Filterable by team, integration, and date range.

NameTypeRequiredDescription
integration_idsstringoptionalComma-separated list of integration IDs. Only change events from these integrations are returned.
limitintegeroptionalThe number of results to return per page.
offsetintegeroptionalOffset to start pagination search results.
sincestringoptionalThe start of the date range to search, as a UTC ISO 8601 datetime string.
team_idsstringoptionalComma-separated list of team IDs. Only change events related to these teams are returned. Account must have the teams ability.
totalbooleanoptionalSet to true to populate the total field in the pagination response, at the cost of slower response times.
untilstringoptionalThe end of the date range to search, as a UTC ISO 8601 datetime string.
pagerduty_escalation_policies_list#List escalation policies in PagerDuty. Supports filtering by query, user, team, and includes.7 params

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

NameTypeRequiredDescription
includestringoptionalAdditional resources to include. Options: services, teams, targets.
limitintegeroptionalThe number of results per page. Maximum 100.
offsetintegeroptionalOffset to start pagination search results.
querystringoptionalFilters the results by name.
sort_bystringoptionalUsed to specify a field to sort the response on. Options: name, name:asc, name:desc.
team_idsstringoptionalComma-separated list of team IDs to filter escalation policies by.
user_idsstringoptionalComma-separated list of user IDs to filter escalation policies for.
pagerduty_escalation_policy_create#Create a new escalation policy in PagerDuty. Escalation policies define who gets notified and in what order when an incident is triggered.7 params

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

NameTypeRequiredDescription
namestringrequiredThe name of the escalation policy.
target_idstringrequiredThe ID of the user or schedule to notify in the first escalation rule.
descriptionstringoptionalA description of the escalation policy.
num_loopsintegeroptionalThe number of times the escalation policy will repeat after reaching the end of its escalation rules.
on_call_handoff_notificationsstringoptionalDetermines how on call handoff notifications will be sent for users on the escalation policy. Options: if_has_services, always.
rule_escalation_delay_in_minutesintegeroptionalThe number of minutes before an unacknowledged incident escalates to the next rule.
target_typestringoptionalThe type of the first escalation rule target. Options: user_reference, schedule_reference.
pagerduty_escalation_policy_delete#Delete a PagerDuty escalation policy. The policy must not be in use by any services or schedules.1 param

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

NameTypeRequiredDescription
idstringrequiredThe ID of the escalation policy to delete.
pagerduty_escalation_policy_get#Get details of a specific PagerDuty escalation policy by its ID.2 params

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

NameTypeRequiredDescription
idstringrequiredThe ID of the escalation policy to retrieve.
includestringoptionalAdditional resources to include. Options: services, teams, targets.
pagerduty_escalation_policy_update#Update an existing PagerDuty escalation policy's name, description, or loop settings.5 params

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

NameTypeRequiredDescription
idstringrequiredThe ID of the escalation policy to update.
descriptionstringoptionalUpdated description of the escalation policy.
namestringoptionalThe updated name of the escalation policy.
num_loopsintegeroptionalThe number of times the escalation policy will repeat after reaching the end.
on_call_handoff_notificationsstringoptionalDetermines how on-call handoff notifications are sent. Options: if_has_services, always.
pagerduty_incident_alert_get#Get detailed information about a single alert on a PagerDuty incident.2 params

Get detailed information about a single alert on a PagerDuty incident.

NameTypeRequiredDescription
alert_idstringrequiredThe unique PagerDuty alert ID.
idstringrequiredThe unique PagerDuty incident ID.
pagerduty_incident_alert_update#Update the status of a single alert on a PagerDuty incident, or reassign it to a different incident.5 params

Update the status of a single alert on a PagerDuty incident, or reassign it to a different incident.

NameTypeRequiredDescription
alert_idstringrequiredThe unique PagerDuty alert ID to update.
from_emailstringrequiredMust be a valid PagerDuty user email address.
idstringrequiredThe unique PagerDuty incident ID the alert belongs to.
statusstringrequiredThe status to apply to the alert.
target_incident_idstringoptionalIf set, reassigns the alert to this incident instead of updating status.
pagerduty_incident_alerts_list#List alerts for a specific PagerDuty incident. Supports filtering by status and alert key.7 params

List alerts for a specific PagerDuty incident. Supports filtering by status and alert key.

NameTypeRequiredDescription
idstringrequiredThe unique PagerDuty incident ID.
alert_keystringoptionalFilter alerts by their deduplication key.
includestringoptionalComma-separated list of resources to sideload. Options: services, first_trigger_log_entries, incidents.
limitintegeroptionalNumber of results per page (max 100).
offsetintegeroptionalNumber of records to skip for pagination.
sort_bystringoptionalField to sort results by, e.g. created_at:desc.
statusesstringoptionalComma-separated list of statuses to filter by. Options: triggered, resolved.
pagerduty_incident_alerts_manage#Bulk-update the status of multiple alerts on a PagerDuty incident, or reassign them to a different incident. A maximum of 250 alerts may be updated at a time.5 params

Bulk-update the status of multiple alerts on a PagerDuty incident, or reassign them to a different incident. A maximum of 250 alerts may be updated at a time.

NameTypeRequiredDescription
alert_idsstringrequiredComma-separated list of alert IDs to update.
from_emailstringrequiredMust be a valid PagerDuty user email address.
idstringrequiredThe unique PagerDuty incident ID the alerts belong to.
statusstringrequiredThe status to apply to all specified alerts.
target_incident_idstringoptionalIf set, reassigns the alerts to this incident instead of updating status.
pagerduty_incident_create#Create a new incident in PagerDuty. Requires a title, service ID, and the email of the user creating the incident.8 params

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

NameTypeRequiredDescription
from_emailstringrequiredThe email address of the user creating the incident. Required by PagerDuty.
service_idstringrequiredThe ID of the service the incident belongs to.
titlestringrequiredA brief description of the incident.
body_detailsstringoptionalAdditional details about the incident body (plain text).
escalation_policy_idstringoptionalThe ID of the escalation policy to assign to the incident.
incident_keystringoptionalA string that identifies the incident. Used for deduplication.
priority_idstringoptionalThe ID of the priority to assign to the incident.
urgencystringoptionalThe urgency of the incident. Options: high, low.
pagerduty_incident_custom_fields_list#List the custom fields defined for enriching incidents. Existing tools can create and update incidents but nothing else inspects what custom fields are configured for them.1 param

List the custom fields defined for enriching incidents. Existing tools can create and update incidents but nothing else inspects what custom fields are configured for them.

NameTypeRequiredDescription
includestringoptionalAdditional details to include in the response alongside each field. Only supported value is 'field_options'.
pagerduty_incident_get#Get details of a specific PagerDuty incident by its ID, including status, assignments, services, and timeline.1 param

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

NameTypeRequiredDescription
idstringrequiredThe ID of the incident to retrieve.
pagerduty_incident_log_entries_list#List log entries for a specific PagerDuty incident, scoped to that incident only.6 params

List log entries for a specific PagerDuty incident, scoped to that incident only.

NameTypeRequiredDescription
idstringrequiredThe unique PagerDuty incident ID.
includestringoptionalComma-separated list of resources to sideload. Options: incidents, services, channels, teams.
is_overviewbooleanoptionalReturn only the most relevant log entries for an overview.
sincestringoptionalStart datetime in ISO 8601 format, e.g. 2024-01-01T00:00:00Z.
time_zonestringoptionalIANA time zone for the response.
untilstringoptionalEnd datetime in ISO 8601 format, e.g. 2024-12-31T23:59:59Z.
pagerduty_incident_manage#Manage multiple PagerDuty incidents in bulk. Acknowledge, resolve, merge, or reassign multiple incidents at once.3 params

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

NameTypeRequiredDescription
from_emailstringrequiredThe email address of the user performing the bulk action. Required by PagerDuty.
incident_idsstringrequiredComma-separated list of incident IDs to manage.
statusstringrequiredThe status to apply to all specified incidents. Options: acknowledged, resolved.
pagerduty_incident_merge#Merge one or more source incidents into a target incident. After the merge, the target incident contains the source incidents' alerts and the source incidents are resolved.3 params

Merge one or more source incidents into a target incident. After the merge, the target incident contains the source incidents' alerts and the source incidents are resolved.

NameTypeRequiredDescription
from_emailstringrequiredMust be a valid PagerDuty user email address.
idstringrequiredThe ID of the incident that source incidents will be merged into.
source_incident_idsstringrequiredComma-separated list of incident IDs to merge into the target incident.
pagerduty_incident_note_create#Add a note to a PagerDuty incident. Notes are visible to all responders on the incident.3 params

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

NameTypeRequiredDescription
contentstringrequiredThe content of the note to add to the incident.
from_emailstringrequiredThe email address of the user creating the note. Required by PagerDuty.
idstringrequiredThe ID of the incident to add a note to.
pagerduty_incident_notes_list#List existing notes for a PagerDuty incident.1 param

List existing notes for a PagerDuty incident.

NameTypeRequiredDescription
idstringrequiredThe unique PagerDuty incident ID.
pagerduty_incident_responder_request_create#Ask additional users or escalation policies to respond to a PagerDuty incident. At least one of user_ids or escalation_policy_ids must be provided.5 params

Ask additional users or escalation policies to respond to a PagerDuty incident. At least one of user_ids or escalation_policy_ids must be provided.

NameTypeRequiredDescription
idstringrequiredThe unique PagerDuty incident ID.
messagestringrequiredThe message sent with the responder request.
requester_idstringrequiredThe PagerDuty user ID of the person making the request.
escalation_policy_idsstringoptionalComma-separated list of escalation policy IDs to request as responders.
user_idsstringoptionalComma-separated list of user IDs to request as responders.
pagerduty_incident_snooze#Snooze a PagerDuty incident for a specified number of seconds. After the duration elapses, the incident returns to the triggered state.3 params

Snooze a PagerDuty incident for a specified number of seconds. After the duration elapses, the incident returns to the triggered state.

NameTypeRequiredDescription
durationintegerrequiredThe number of seconds to snooze the incident for (1 to 604800).
from_emailstringrequiredMust be a valid PagerDuty user email address.
idstringrequiredThe unique PagerDuty incident ID.
pagerduty_incident_status_update_create#Post a status update on a PagerDuty incident, visible to subscribers.3 params

Post a status update on a PagerDuty incident, visible to subscribers.

NameTypeRequiredDescription
from_emailstringrequiredMust be a valid PagerDuty user email address.
idstringrequiredThe unique PagerDuty incident ID.
messagestringrequiredThe message to post as a status update.
pagerduty_incident_update#Update an existing PagerDuty incident. Can change status, urgency, title, priority, escalation policy, or reassign it.9 params

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

NameTypeRequiredDescription
from_emailstringrequiredThe email address of the user making the update. Required by PagerDuty.
idstringrequiredThe ID of the incident to update.
assignee_idstringoptionalThe ID of the user to assign the incident to.
escalation_policy_idstringoptionalThe ID of the escalation policy to assign to the incident.
priority_idstringoptionalThe ID of the priority to assign to the incident.
resolutionstringoptionalThe resolution note for the incident (used when resolving).
statusstringoptionalThe new status of the incident. Options: acknowledged, resolved.
titlestringoptionalA brief description of the incident.
urgencystringoptionalThe urgency of the incident. Options: high, low.
pagerduty_incidents_list#List existing incidents in PagerDuty. Supports filtering by status, urgency, service, team, assigned user, and date range.12 params

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

NameTypeRequiredDescription
date_rangestringoptionalWhen set to 'all', the since and until parameters and defaults are ignored.
includestringoptionalArray of additional resources to include. Options: acknowledgers, agents, assignees, conference_bridge, escalation_policies, first_trigger_log_entries, responders, services, teams, users.
limitintegeroptionalThe number of results to return per page. Maximum 100.
offsetintegeroptionalOffset to start pagination search results.
service_idsstringoptionalComma-separated list of service IDs to filter incidents by.
sincestringoptionalThe start of the date range to search (ISO 8601 format).
sort_bystringoptionalUsed to specify a field you would like to sort the response on. Options: incident_number, created_at, resolved_at, urgency.
statusesstringoptionalComma-separated list of statuses to filter by. Options: triggered, acknowledged, resolved.
team_idsstringoptionalComma-separated list of team IDs to filter incidents by.
untilstringoptionalThe end of the date range to search (ISO 8601 format).
urgenciesstringoptionalComma-separated list of urgencies to filter by. Options: high, low.
user_idsstringoptionalComma-separated list of user IDs to filter incidents assigned to.
pagerduty_log_entries_list#List log entries across all incidents in PagerDuty. Log entries record actions taken on incidents including notifications, acknowledgements, and assignments.8 params

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

NameTypeRequiredDescription
includestringoptionalAdditional resources to include. Options: incidents, services, channels, teams.
is_overviewbooleanoptionalIf true, only show log entries of type 'notify_log_entry'.
limitintegeroptionalThe number of results per page. Maximum 100.
offsetintegeroptionalOffset to start pagination search results.
sincestringoptionalThe start of the date range (ISO 8601).
team_idsstringoptionalComma-separated list of team IDs to filter log entries by.
time_zonestringoptionalTime zone for the log entries (IANA format).
untilstringoptionalThe end of the date range (ISO 8601).
pagerduty_log_entry_get#Get details of a specific PagerDuty log entry by its ID.3 params

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

NameTypeRequiredDescription
idstringrequiredThe ID of the log entry to retrieve.
includestringoptionalAdditional resources to include. Options: incidents, services, channels, teams.
time_zonestringoptionalTime zone for the log entry (IANA format).
pagerduty_maintenance_window_create#Create a new maintenance window in PagerDuty. During a maintenance window, no incidents will be created for the associated services.5 params

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

NameTypeRequiredDescription
end_timestringrequiredThe end time of the maintenance window (ISO 8601 format).
from_emailstringrequiredThe email address of the user creating the maintenance window. Required by PagerDuty.
service_idsstringrequiredComma-separated list of service IDs to include in the maintenance window.
start_timestringrequiredThe start time of the maintenance window (ISO 8601 format).
descriptionstringoptionalA description of the maintenance window.
pagerduty_maintenance_window_delete#Delete a PagerDuty maintenance window. Only future and ongoing maintenance windows may be deleted.1 param

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

NameTypeRequiredDescription
idstringrequiredThe ID of the maintenance window to delete.
pagerduty_maintenance_window_get#Get details of a specific PagerDuty maintenance window by its ID.2 params

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

NameTypeRequiredDescription
idstringrequiredThe ID of the maintenance window to retrieve.
includestringoptionalAdditional resources to include. Options: services, teams.
pagerduty_maintenance_window_update#Update an existing PagerDuty maintenance window's description, start time, or end time.4 params

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

NameTypeRequiredDescription
idstringrequiredThe ID of the maintenance window to update.
descriptionstringoptionalUpdated description of the maintenance window.
end_timestringoptionalUpdated end time of the maintenance window (ISO 8601 format).
start_timestringoptionalUpdated start time of the maintenance window (ISO 8601 format).
pagerduty_maintenance_windows_list#List maintenance windows in PagerDuty. Maintenance windows disable incident notifications for services during scheduled maintenance periods.7 params

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

NameTypeRequiredDescription
filterstringoptionalFilter maintenance windows by time. Options: past, future, ongoing.
includestringoptionalAdditional resources to include. Options: services, teams.
limitintegeroptionalThe number of results per page. Maximum 100.
offsetintegeroptionalOffset to start pagination search results.
querystringoptionalFilters the results by description.
service_idsstringoptionalComma-separated list of service IDs to filter maintenance windows by.
team_idsstringoptionalComma-separated list of team IDs to filter maintenance windows by.
pagerduty_notifications_list#List notifications sent for incidents in a given time range. Notifications are messages sent to users when incidents are triggered, acknowledged, or resolved.7 params

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

NameTypeRequiredDescription
sincestringrequiredThe start of the date range (ISO 8601). Required.
untilstringrequiredThe end of the date range (ISO 8601). Required.
filterstringoptionalFilters the results by notification type. Options: sms_notification, email_notification, phone_notification, push_notification.
includestringoptionalAdditional resources to include. Options: users.
limitintegeroptionalThe number of results per page. Maximum 100.
offsetintegeroptionalOffset to start pagination search results.
time_zonestringoptionalTime zone for the notification data (IANA format).
pagerduty_oncalls_list#List who is on call right now or within a date range. Supports filtering by schedule, escalation policy, and user.10 params

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

NameTypeRequiredDescription
earliestbooleanoptionalWhen set to true, returns only the earliest on-call for each combination of escalation policy, escalation level, and user.
escalation_policy_idsstringoptionalComma-separated list of escalation policy IDs to filter by.
includestringoptionalAdditional resources to include. Options: users, schedules, escalation_policies.
limitintegeroptionalThe number of results per page. Maximum 100.
offsetintegeroptionalOffset to start pagination search results.
schedule_idsstringoptionalComma-separated list of schedule IDs to filter by.
sincestringoptionalThe start of the time range to retrieve on-call information (ISO 8601).
time_zonestringoptionalTime zone for the on-call data (IANA format).
untilstringoptionalThe end of the time range to retrieve on-call information (ISO 8601).
user_idsstringoptionalComma-separated list of user IDs to filter on-calls by.
pagerduty_priorities_list#List the priority options available for incidents in PagerDuty. Returns all configured priority levels.0 params

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

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

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

NameTypeRequiredDescription
layer_startstringrequiredThe start time of the schedule layer (ISO 8601 format).
namestringrequiredThe name of the schedule.
rotation_virtual_startstringrequiredThe effective start time of the rotation to align turn order (ISO 8601 format).
time_zonestringrequiredThe time zone of the schedule (IANA format, e.g., America/New_York).
user_idsstringrequiredComma-separated list of user IDs to include in the rotation.
descriptionstringoptionalA description of the schedule.
layer_namestringoptionalThe name of the first schedule layer.
rotation_turn_length_secondsintegeroptionalThe duration of each on-call rotation turn in seconds (e.g., 86400 = 1 day, 604800 = 1 week).
pagerduty_schedule_delete#Delete a PagerDuty on-call schedule. The schedule must not be associated with any escalation policies.1 param

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

NameTypeRequiredDescription
idstringrequiredThe ID of the schedule to delete.
pagerduty_schedule_get#Get details of a specific PagerDuty on-call schedule by its ID, including layers and users.4 params

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

NameTypeRequiredDescription
idstringrequiredThe ID of the schedule to retrieve.
sincestringoptionalThe start of the date range to show schedule entries for (ISO 8601).
time_zonestringoptionalTime zone of the displayed schedule (IANA format).
untilstringoptionalThe end of the date range to show schedule entries for (ISO 8601).
pagerduty_schedule_override_create#Create a temporary on-call override for a PagerDuty schedule, assigning a specific user to be on call for a time window.4 params

Create a temporary on-call override for a PagerDuty schedule, assigning a specific user to be on call for a time window.

NameTypeRequiredDescription
endstringrequiredThe end date and time of the override, in ISO 8601 format.
idstringrequiredThe unique PagerDuty schedule ID.
startstringrequiredThe start date and time of the override, in ISO 8601 format.
user_idstringrequiredThe ID of the user who should be on call during the override.
pagerduty_schedule_override_delete#Delete an on-call override from a PagerDuty schedule.2 params

Delete an on-call override from a PagerDuty schedule.

NameTypeRequiredDescription
idstringrequiredThe unique PagerDuty schedule ID.
override_idstringrequiredThe unique ID of the override to delete.
pagerduty_schedule_overrides_list#List the on-call overrides for a PagerDuty schedule within a date range.5 params

List the on-call overrides for a PagerDuty schedule within a date range.

NameTypeRequiredDescription
idstringrequiredThe unique PagerDuty schedule ID.
sincestringrequiredStart of the date range to list overrides for, in ISO 8601 format.
untilstringrequiredEnd of the date range to list overrides for, in ISO 8601 format.
editablebooleanoptionalIf true, only returns overrides that can still be edited.
overflowbooleanoptionalIf true, includes overrides that overflow outside the since/until range.
pagerduty_schedule_update#Update an existing PagerDuty on-call schedule's name, description, or time zone.4 params

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

NameTypeRequiredDescription
idstringrequiredThe ID of the schedule to update.
descriptionstringoptionalUpdated description of the schedule.
namestringoptionalUpdated name of the schedule.
time_zonestringoptionalUpdated time zone (IANA format, e.g., America/New_York).
pagerduty_schedule_users_list#List the users on call for a PagerDuty schedule within an optional date range.3 params

List the users on call for a PagerDuty schedule within an optional date range.

NameTypeRequiredDescription
idstringrequiredThe unique PagerDuty schedule ID.
sincestringoptionalStart of the date range in ISO 8601 format.
untilstringoptionalEnd of the date range in ISO 8601 format.
pagerduty_schedules_list#List on-call schedules in PagerDuty. Supports filtering by query string and pagination.4 params

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

NameTypeRequiredDescription
includestringoptionalAdditional resources to include. Options: schedule_layers, teams, users.
limitintegeroptionalThe number of results per page. Maximum 100.
offsetintegeroptionalOffset to start pagination search results.
querystringoptionalFilters the results by name.
pagerduty_service_create#Create a new service in PagerDuty. A service represents something you monitor and manage incidents for.6 params

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

NameTypeRequiredDescription
escalation_policy_idstringrequiredThe ID of the escalation policy to assign to this service.
namestringrequiredThe name of the service.
acknowledgement_timeoutintegeroptionalTime in seconds that an incident is automatically re-triggered after being acknowledged. Set to 0 to disable.
alert_creationstringoptionalWhether a service creates only incidents or creates both incidents and alerts. Options: create_incidents, create_alerts_and_incidents.
auto_resolve_timeoutintegeroptionalTime in seconds that an incident is automatically resolved if left open. Set to 0 to disable.
descriptionstringoptionalThe user-provided description of the service.
pagerduty_service_delete#Delete an existing PagerDuty service. This action is irreversible. Only services without open incidents may be deleted.1 param

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

NameTypeRequiredDescription
idstringrequiredThe ID of the service to delete.
pagerduty_service_get#Get details of a specific PagerDuty service by its ID.2 params

Get details of a specific PagerDuty service by its ID.

NameTypeRequiredDescription
idstringrequiredThe ID of the service to retrieve.
includestringoptionalAdditional resources to include. Options: escalation_policies, teams, integrations.
pagerduty_service_update#Update an existing PagerDuty service. Can change name, description, escalation policy, timeouts, and alert creation settings.8 params

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

NameTypeRequiredDescription
idstringrequiredThe ID of the service to update.
acknowledgement_timeoutintegeroptionalTime in seconds that an incident is automatically re-triggered after being acknowledged.
alert_creationstringoptionalWhether a service creates only incidents or also alerts. Options: create_incidents, create_alerts_and_incidents.
auto_resolve_timeoutintegeroptionalTime in seconds that an incident is automatically resolved if left open.
descriptionstringoptionalThe user-provided description of the service.
escalation_policy_idstringoptionalThe ID of the escalation policy to assign to this service.
namestringoptionalThe name of the service.
statusstringoptionalThe current state of the service. Options: active, warning, critical, maintenance, disabled.
pagerduty_services_list#List existing services in PagerDuty. Supports filtering by team, query string, and pagination.6 params

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

NameTypeRequiredDescription
includestringoptionalAdditional resources to include. Options: escalation_policies, teams, integrations, auto_pause_notifications_parameters.
limitintegeroptionalThe number of results per page. Maximum 100.
offsetintegeroptionalOffset to start pagination search results.
querystringoptionalFilters the results by name.
sort_bystringoptionalSort results by this field. Options: name, name:asc, name:desc.
team_idsstringoptionalComma-separated list of team IDs to filter services by.
pagerduty_tag_create#Create a new tag, which can then be assigned to escalation policies, teams, or users to filter and group them.1 param

Create a new tag, which can then be assigned to escalation policies, teams, or users to filter and group them.

NameTypeRequiredDescription
labelstringrequiredThe label of the tag. Maximum 191 characters.
pagerduty_tags_list#List tags, which can be applied to escalation policies, teams, and users to filter and group them. Supports filtering by label text and standard offset pagination.4 params

List tags, which can be applied to escalation policies, teams, and users to filter and group them. Supports filtering by label text and standard offset pagination.

NameTypeRequiredDescription
limitintegeroptionalThe number of results to return per page.
offsetintegeroptionalOffset to start pagination search results.
querystringoptionalFilters the result, showing only the tags whose label matches the query.
totalbooleanoptionalSet to true to populate the total field in the pagination response, at the cost of slower response times.
pagerduty_team_create#Create a new team in PagerDuty. Teams allow grouping of users and services.2 params

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

NameTypeRequiredDescription
namestringrequiredThe name of the team.
descriptionstringoptionalA description of the team.
pagerduty_team_delete#Delete a PagerDuty team. The team must have no associated users, services, or escalation policies before it can be deleted.1 param

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

NameTypeRequiredDescription
idstringrequiredThe ID of the team to delete.
pagerduty_team_escalation_policy_add#Associate an escalation policy with a PagerDuty team.2 params

Associate an escalation policy with a PagerDuty team.

NameTypeRequiredDescription
escalation_policy_idstringrequiredThe unique PagerDuty escalation policy ID to add to the team.
idstringrequiredThe unique PagerDuty team ID.
pagerduty_team_escalation_policy_remove#Remove an escalation policy from a PagerDuty team.2 params

Remove an escalation policy from a PagerDuty team.

NameTypeRequiredDescription
escalation_policy_idstringrequiredThe unique PagerDuty escalation policy ID to remove from the team.
idstringrequiredThe unique PagerDuty team ID.
pagerduty_team_get#Get details of a specific PagerDuty team by its ID.1 param

Get details of a specific PagerDuty team by its ID.

NameTypeRequiredDescription
idstringrequiredThe ID of the team to retrieve.
pagerduty_team_members_list#List the members of a PagerDuty team.4 params

List the members of a PagerDuty team.

NameTypeRequiredDescription
idstringrequiredThe unique PagerDuty team ID.
includestringoptionalAdditional resources to include. Options: users.
limitintegeroptionalNumber of results per page (max 100).
offsetintegeroptionalNumber of records to skip for pagination.
pagerduty_team_update#Update an existing PagerDuty team's name or description.3 params

Update an existing PagerDuty team's name or description.

NameTypeRequiredDescription
idstringrequiredThe ID of the team to update.
descriptionstringoptionalUpdated description of the team.
namestringoptionalThe updated name of the team.
pagerduty_team_user_add#Add a user to a PagerDuty team with a given role.3 params

Add a user to a PagerDuty team with a given role.

NameTypeRequiredDescription
idstringrequiredThe unique PagerDuty team ID.
user_idstringrequiredThe unique PagerDuty user ID to add to the team.
rolestringoptionalThe role of the user on the team.
pagerduty_team_user_remove#Remove a user from a PagerDuty team.2 params

Remove a user from a PagerDuty team.

NameTypeRequiredDescription
idstringrequiredThe unique PagerDuty team ID.
user_idstringrequiredThe unique PagerDuty user ID to remove from the team.
pagerduty_teams_list#List teams in PagerDuty. Supports filtering by query string and pagination.3 params

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

NameTypeRequiredDescription
limitintegeroptionalThe number of results per page. Maximum 100.
offsetintegeroptionalOffset to start pagination search results.
querystringoptionalFilters the results by name.
pagerduty_user_create#Create a new user in PagerDuty. Requires name, email, and the creating user's email in the From header.6 params

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

NameTypeRequiredDescription
emailstringrequiredThe user's email address.
from_emailstringrequiredThe email address of the admin creating this user. Required by PagerDuty.
namestringrequiredThe name of the user.
colorstringoptionalThe schedule color for the user.
rolestringoptionalThe user's role. Options: admin, limited_user, observer, owner, read_only_user, restricted_access, read_only_limited_user, user.
time_zonestringoptionalThe time zone of the user (IANA format, e.g., America/New_York).
pagerduty_user_delete#Delete a PagerDuty user. Users cannot be deleted if they are the only remaining account owner.1 param

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

NameTypeRequiredDescription
idstringrequiredThe ID of the user to delete.
pagerduty_user_get#Get details of a specific PagerDuty user by their ID.2 params

Get details of a specific PagerDuty user by their ID.

NameTypeRequiredDescription
idstringrequiredThe ID of the user to retrieve.
includestringoptionalAdditional resources to include. Options: contact_methods, notification_rules, teams.
pagerduty_user_me_get#Get details of the PagerDuty user associated with the current authentication credentials.1 param

Get details of the PagerDuty user associated with the current authentication credentials.

NameTypeRequiredDescription
includestringoptionalAdditional resources to include. Options: contact_methods, notification_rules, teams, subdomains, calendar_urls.
pagerduty_user_update#Update an existing PagerDuty user's profile including name, email, role, time zone, and color.6 params

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

NameTypeRequiredDescription
idstringrequiredThe ID of the user to update.
colorstringoptionalThe schedule color for the user.
emailstringoptionalThe user's updated email address.
namestringoptionalThe updated name of the user.
rolestringoptionalThe user's role. Options: admin, limited_user, observer, owner, read_only_user, restricted_access, read_only_limited_user, user.
time_zonestringoptionalThe time zone of the user (IANA format, e.g., America/New_York).
pagerduty_users_list#List users in PagerDuty. Supports filtering by query, team, and includes.5 params

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

NameTypeRequiredDescription
includestringoptionalAdditional resources to include. Options: contact_methods, notification_rules, teams.
limitintegeroptionalThe number of results per page. Maximum 100.
offsetintegeroptionalOffset to start pagination search results.
querystringoptionalFilters the results by name.
team_idsstringoptionalComma-separated list of team IDs to filter users by.
pagerduty_vendor_get#Get details of a specific PagerDuty vendor (integration type) by its ID.1 param

Get details of a specific PagerDuty vendor (integration type) by its ID.

NameTypeRequiredDescription
idstringrequiredThe unique PagerDuty vendor ID.
pagerduty_vendors_list#List available PagerDuty vendors (integration types). Vendors represent the services or monitoring tools that can be integrated with PagerDuty.3 params

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

NameTypeRequiredDescription
limitintegeroptionalThe number of results per page. Maximum 100.
offsetintegeroptionalOffset to start pagination search results.
querystringoptionalFilters the results by vendor name.