- Category: server monitoring
- Auth: OAUTH2, API_KEY
- Composio-managed OAuth available? Yes
- Tools: 368
- Triggers: 0
- Slug:
PAGERDUTY - Version: 20261101_00
Tools
Add service to incident workflow trigger
Add service to incident workflow trigger
PAGERDUTY_ADD_SERVICE_TO_INCIDENT_WORKFLOW_TRIGGERAdds a service to an existing incident workflow trigger in PagerDuty, enabling the trigger to fire for incidents on that service. Associates a specific service with an incident workflow trigger to automate incident management for that service. Prerequisites: - The incident workflow trigger must already exist (create with CREATE_A_TRIGGER) - The service must already exist in your account - The trigger must not be subscribed to all services Use when expanding automated workflows to additional services or incrementally rolling out workflows. This is an additive operation - use DELETE_INCIDENT_WORKFLOW_TRIGGER_SERVICE to remove services. Requires incident_workflows:write OAuth scope.Input Parameters
Output
Aggregate escalation policy incident metrics
Aggregate escalation policy incident metrics
PAGERDUTY_AGGREGATE_ESCALATION_POLICY_INCIDENT_METRICSThis endpoint analyzes and aggregates incident metrics across all escalation policies in PagerDuty. It allows for detailed filtering and customization of the analysis, enabling users to gain insights into incident patterns, response times, and escalation effectiveness. The endpoint is particularly useful for operational reviews, performance analysis, and identifying areas for improvement in incident management processes. It provides flexibility in data selection through various filters and supports different time-based aggregations for comprehensive reporting.Input Parameters
Output
Aggregate incident metrics with filters
Aggregate incident metrics with filters
PAGERDUTY_AGGREGATE_INCIDENT_METRICS_WITH_FILTERSRetrieves and aggregates metrics for incidents across all services in PagerDuty. This endpoint allows for extensive filtering and customization of incident data, enabling detailed analysis of operational performance. It’s particularly useful for generating reports, identifying trends, and assessing incident management efficiency over specified time periods. The endpoint supports various filtering criteria, time zone adjustments, and aggregation options, making it a powerful tool for both high-level overviews and granular incident analytics. However, users should be aware of the complexity of the filtering options and ensure they provide accurate parameters to obtain relevant data.Input Parameters
Output
Associate service dependencies
Associate service dependencies
PAGERDUTY_ASSOCIATE_SERVICE_DEPENDENCIESAssociates multiple service dependencies in PagerDuty, allowing you to define relationships between supporting and dependent services. This endpoint is used to establish a hierarchical structure of services, which is crucial for effective incident management and impact analysis. It enables you to create multiple dependencies in a single API call, improving efficiency when setting up complex service relationships. Use this endpoint when you need to define or update the dependency structure of your services in PagerDuty, such as during initial setup, service restructuring, or when adding new services to your incident management workflow.Input Parameters
Output
Associate team with automation action
Associate team with automation action
PAGERDUTY_ASSOCIATE_TEAM_WITH_AUTOMATION_ACTIONThis endpoint associates a specific team with an automation action in PagerDuty. It allows you to link a team to an automated workflow, enabling better organization and management of automation actions within your incident response processes. Use this endpoint when you need to assign responsibility for an automation action to a particular team or when restructuring your automation workflows. The association helps in tracking, auditing, and managing permissions for automation actions across different teams in your organization. Note that this endpoint only creates the association; it does not create new teams or automation actions.Input Parameters
Output
Audit escalation policy records
Audit escalation policy records
PAGERDUTY_AUDIT_ESCALATION_POLICY_RECORDSRetrieves the audit records for a specific escalation policy in PagerDuty. This endpoint allows users to access a detailed history of changes made to the escalation policy, including modifications to escalation rules, associated services, and on-call schedules. It’s particularly useful for compliance tracking, troubleshooting, and understanding how the incident response process has been adjusted over time. The audit records provide transparency into who made changes, what was changed, and when the changes occurred, helping teams maintain accountability and optimize their incident management workflows.Input Parameters
limit parameter used in the request or the maximum request size of the API.now() - 24 hours (past 24 hours)now(). May not be more than 31 days after since.next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.Output
Convert service rule by id
Convert service rule by id
PAGERDUTY_CONVERT_SERVICE_RULE_BY_IDConverts a service’s legacy Event Rules into Event Orchestration rules; rules with unsupported exceptions may not be fully supported. Conversion does not automatically enable Service Event Orchestration, which must be enabled separately for the rules to process events.Input Parameters
Output
Count paused incident reports
Count paused incident reports
PAGERDUTY_COUNT_PAUSED_INCIDENT_REPORTSRetrieves counts of alerts paused during a reporting period, including counts triggered or resolved after the pause. Results can be scoped by service and suspension method.Input Parameters
Output
Create a custom field for an incident type
Create a custom field for an incident type
PAGERDUTY_CREATE_A_CUSTOM_FIELD_FOR_AN_INCIDENT_TYPECreates a custom field for an incident type, extending incidents with custom data for context, filtering, search, and analytics.Input Parameters
Output
Create a field option for a custom field
Create a field option for a custom field
PAGERDUTY_CREATE_A_FIELD_OPTION_FOR_A_CUSTOM_FIELDCreates a selectable field option for a custom field on an incident type.Input Parameters
Output
Create and manage custom incident fields
Create and manage custom incident fields
PAGERDUTY_CREATE_AND_MANAGE_CUSTOM_INCIDENT_FIELDSCreates a new custom field for incidents in PagerDuty. This endpoint allows you to define additional data points to be associated with incidents, enhancing incident management and reporting capabilities. Custom fields can be used to store various types of information such as environment, severity, or any other relevant metadata. The field can be configured with different data types and value constraints, allowing for flexible and structured data capture. Use this endpoint when you need to extend the incident data model with organization-specific information. Note that once created, certain properties of a custom field cannot be changed, so careful planning of field structure is important. DEPRECATED: PagerDuty has deprecated this Base Incident Type endpoint. Use create_a_custom_field_for_an_incident_type for new integrations.Input Parameters
Output
Create an incident type
Create an incident type
PAGERDUTY_CREATE_AN_INCIDENT_TYPECreates an incident type for categorizing PagerDuty incidents, such as security, major, or fraud incidents. Scoped OAuth requires incident_types.write.Input Parameters
_default is prohibited. This cannot be changed once the incident type has been created.PD, PagerDuty, Default is prohibited.Output
Create a ruleset
Create a ruleset
Create incident workflow trigger
Create incident workflow trigger
Create automation runner endpoint
Create automation runner endpoint
PAGERDUTY_CREATE_AUTOMATION_RUNNER_ENDPOINTCreates a new Runbook Automation runner in PagerDuty’s Automation Actions. A runner is the execution engine that invokes automation actions. Only ‘runbook’ type runners can be created via API. Required fields: runner_type (‘runbook’), name (max 255 chars), description (max 1024 chars), runbook_base_uri (your Runbook instance subdomain), and runbook_api_key (User API token from Runbook). Use this to connect a Runbook Automation server to PagerDuty for executing automation actions during incidents. Requires a subscription with Automation Actions capabilities.Input Parameters
Output
Create business service
Create business service
PAGERDUTY_CREATE_BUSINESS_SERVICEThis endpoint creates a new Business Service in PagerDuty, which represents a specific service or application that can be monitored and managed within the incident management platform. It allows you to define essential properties of the service, including its name, description, point of contact, and the team responsible for it. Use this endpoint when you need to add a new service to your PagerDuty account for monitoring and incident management. The created Business Service can be later associated with technical services, incidents, and escalation policies. Note that this endpoint only creates the Business Service; additional configuration may be required to set up monitoring and alerting for the service.Input Parameters
Output
Create escalation policy
Create escalation policy
PAGERDUTY_CREATE_ESCALATION_POLICYCreates a new escalation policy in PagerDuty, defining how incidents are escalated to different responders or teams. This endpoint allows you to set up a structured response plan for managing incidents, including escalation rules, targets, and associated services or teams. Use this when setting up or modifying incident management workflows. The created policy determines the sequence of notifications and assignments for unacknowledged incidents. Note that while you can create the policy structure, actual service associations are read-only and must be managed separately. Only one team can be associated with a policy, and the account must have the ‘teams’ ability to use this feature.Input Parameters
Output
Create event orchestration
Create event orchestration
PAGERDUTY_CREATE_EVENT_ORCHESTRATIONCreates a new Event Orchestration in PagerDuty, which defines how incoming events are processed and routed to appropriate services. This endpoint allows you to set up a configuration that manages the flow of events from various integrations, ensuring efficient incident handling. Use this when you need to establish a new set of rules for event routing, especially when introducing new services or reorganizing your incident management workflow. The created Orchestration can later be associated with specific integrations using their routing keys. Note that while you can create the Orchestration structure, the actual integrations and routing details are managed separately and will be populated as read-only information once configured.Input Parameters
Output
Create event rule in ruleset
Create event rule in ruleset
PAGERDUTY_CREATE_EVENT_RULE_IN_RULESETCreates an Event Rule in a specified legacy PagerDuty Ruleset, defining event matching conditions and actions. Rulesets and Event Rules are managed through the API; their web pages have reached end-of-life.Input Parameters
Output
Create extension object
Create extension object
PAGERDUTY_CREATE_EXTENSION_OBJECTCreates a new extension in PagerDuty, allowing for additional functionality or integrations to be added to your services. This endpoint is used to set up webhooks, custom integrations, or other specific features that enhance the capabilities of your PagerDuty account. The extension is defined by its name, associated services, and a specific extension schema that determines its behavior. Use this endpoint when you need to automate the creation of extensions, such as setting up multiple webhooks or implementing custom workflows. It’s particularly useful for large-scale deployments or when programmatically managing your PagerDuty configuration. Note that the extension can be temporarily disabled by PagerDuty if issues arise, such as repeated rejections from a webhook server.Input Parameters
Output
Create handoff notification rule
Create handoff notification rule
PAGERDUTY_CREATE_HANDOFF_NOTIFICATION_RULECreates a new on-call handoff notification rule for a specific user in PagerDuty. This endpoint allows you to set up automated notifications for when a user is about to start or end their on-call shift. It defines how and when the user should be notified about upcoming handoffs, helping to ensure smooth transitions between on-call periods. Use this when you need to establish or modify the way a user is informed about their on-call responsibilities. The rule can be set for incoming shifts, outgoing shifts, or both, and can use various contact methods like email, phone, push notifications, or SMS. Note that this endpoint creates a new rule and does not modify existing ones.Input Parameters
Output
Create incident field option
Create incident field option
PAGERDUTY_CREATE_INCIDENT_FIELD_OPTIONCreates a new field option for a specific custom field in PagerDuty’s incident management system. This endpoint allows you to add predefined options to custom fields, enhancing the ability to categorize and filter incidents with consistent, structured data. Use this when you need to expand the list of selectable values for a string-type custom field. The new option becomes immediately available for selection when updating or creating incidents. Note that this operation is specific to custom fields of type ‘string’ and cannot be used for other data types. Ensure that the field_id in the URL corresponds to an existing custom field in your PagerDuty account.Input Parameters
Output
Create incident record
Create incident record
PAGERDUTY_CREATE_INCIDENT_RECORDCreates a new incident in PagerDuty with specified details and assignments. Use this endpoint when an event requires immediate attention from on-call teams. It supports comprehensive incident documentation, including priority, urgency, and conference bridge information. The ‘incident_key’ parameter helps prevent duplicate incidents, crucial for maintaining a clean incident list.Input Parameters
CURRENT STATUS: [Brief description of current situation] IMPACT: - Business Impact: [Description] - User Impact: [Number of affected users/systems] - Revenue Impact: [If applicable] ACTIONS TAKEN: 1. [Action 1] 2. [Action 2] METRICS: - Error Rate: [Value] - Response Time: [Value] LINKS: - Dashboard: [URL] - Logs: [URL] - Runbook: [URL]Output
Create incident workflow
Create incident workflow
PAGERDUTY_CREATE_INCIDENT_WORKFLOWThis endpoint creates a new Incident Workflow in PagerDuty, allowing users to define a series of automated steps to be executed during incident response. It enables the setup of complex, multi-step processes that can include actions like sending notifications, updating statuses, or triggering other integrated systems. The workflow creation is highly customizable, supporting various action types and nested workflows, making it suitable for diverse incident management scenarios across different team structures and response protocols.Input Parameters
Output
Create incident workflow instance
Create incident workflow instance
PAGERDUTY_CREATE_INCIDENT_WORKFLOW_INSTANCECreates a new instance of an incident workflow for a specific incident in PagerDuty. This endpoint allows you to initiate a predefined workflow process for managing and resolving an ongoing incident. It links the workflow instance to a particular incident, enabling automated and standardized incident response procedures. Use this when you need to start a structured response process for a newly created or existing incident. The endpoint is particularly useful for ensuring consistent handling of incidents across your organization and for tracking the progress of incident resolution through defined stages.Input Parameters
Output
Create integration for orchestration
Create integration for orchestration
PAGERDUTY_CREATE_INTEGRATION_FOR_ORCHESTRATIONCreates a new integration for an existing event orchestration in PagerDuty. This action adds an integration to an event orchestration, enabling it to receive events from external monitoring tools, alerting systems, or custom applications. Each integration gets a unique routing key for use with the PagerDuty Events API v2. Use cases: Connect monitoring tools (Datadog, New Relic, CloudWatch), set up custom alerting systems, create multiple event sources, or separate event streams by environment. Requirements: Event orchestration ID and a descriptive integration label. Returns: Integration with unique ID, routing key for Events API v2, and label. Note: Max 10 integrations per orchestration.Input Parameters
Output
Create integration for service
Create integration for service
PAGERDUTY_CREATE_INTEGRATION_FOR_SERVICECreates a new integration for a PagerDuty service to enable incident creation from external monitoring tools and systems. Integrations can be either generic (using ‘type’ parameter) or vendor-specific (using ‘vendor’ parameter). Common integration types: - events_api_v2_inbound_integration: Modern Events API v2 for custom integrations - generic_events_api_inbound_integration: Generic Events API v1 integration - generic_email_inbound_integration: Email-based incident creation Vendor integrations: Use the ‘vendor’ parameter with an ID from the vendors endpoint to create integrations for specific tools like Datadog, AWS CloudWatch, Nagios, New Relic, etc. Returns: The created integration object with an integration_key (for API integrations) or integration_email (for email integrations) that can be used to send events to PagerDuty. Note: Each integration belongs to exactly one service. Use this action after creating a service to establish monitoring channels.Input Parameters
Output
Create maintenance window object
Create maintenance window object
Create new schedule layer
Create new schedule layer
PAGERDUTY_CREATE_NEW_SCHEDULE_LAYERCreates a new on-call schedule in PagerDuty with one or more rotation layers. A schedule defines who is on-call at any given time. Each schedule contains one or more layers that specify rotation patterns, with each layer having: - User assignments (who participates in the rotation) - Rotation timing (how long each person is on-call) - Time zone for the schedule - Optional restrictions (e.g., only active during business hours) Use this action to: - Set up new on-call rotations for incident response - Define daily, weekly, or custom rotation patterns - Create multi-layer schedules (e.g., business hours + after-hours) - Establish coverage schedules for escalation policies The schedule will be available immediately after creation and can be referenced in escalation policies to route incidents to the right people.Input Parameters
overflow=true is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z: - If you don”t pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T10:00:00Z and end of 2011-06-01T14:00:00Z. - If you do pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.Output
Create new service
Create new service
PAGERDUTY_CREATE_NEW_SERVICECreates a new service in PagerDuty, which is a key component for managing incidents and alerts. This endpoint allows you to set up a service with various configurations including escalation policies, incident urgency rules, support hours, and alert grouping parameters. Use this when you need to add a new monitored service to your PagerDuty account, such as a new application, infrastructure component, or business process. The created service will be used as a target for incoming alerts and incidents, helping to organize and streamline your incident management process. Note that some advanced features like intelligent alert grouping may depend on your PagerDuty plan.Input Parameters
Output
Create new tag in system
Create new tag in system
PAGERDUTY_CREATE_NEW_TAG_IN_SYSTEMCreates a new tag in PagerDuty for labeling and categorizing entities. This endpoint allows users to add a custom label to their PagerDuty account, which can be used to organize and filter various resources such as incidents, services, or teams. The created tag can be subsequently assigned to relevant entities to improve organization and searchability within the PagerDuty platform. Use this endpoint when you need to introduce a new categorization or labeling scheme in your PagerDuty setup. Note that this endpoint only creates the tag; assigning it to specific entities would require separate API calls.Input Parameters
Output
Create new team with details
Create new team with details
PAGERDUTY_CREATE_NEW_TEAM_WITH_DETAILSCreates a new team in PagerDuty for organizing users, incident management, and on-call schedules. Required: team.name (unique team name) Optional: team.description, team.parent (for nested hierarchies), team.default_role Use when setting up departments, project teams, or organizing users with shared incident response responsibilities. After creation, use separate API calls to add members to the team. Examples: - Basic: {“team”: {“name”: “Platform Team”}} - With details: {“team”: {“name”: “SRE Team”, “description”: “Site Reliability Engineering”}} - Nested: {“team”: {“name”: “Backend API”, “parent”: “PXXXXXX”, “default_role”: “responder”}} Note: Requires paid PagerDuty plan with Teams feature enabled.Input Parameters
Output
Create new webhook subscription
Create new webhook subscription
PAGERDUTY_CREATE_NEW_WEBHOOK_SUBSCRIPTIONCreates a new webhook subscription in PagerDuty to receive specific event notifications. This endpoint allows users to set up automated notifications for various incident-related events, such as triggers, acknowledgments, and resolutions. The webhook can be configured to filter events by service, team, or account-wide, and supports custom HTTP headers for enhanced integration capabilities. Use this when you need to integrate PagerDuty’s real-time incident updates with external systems or workflows. Note that the webhook’s secret for payload verification is only provided in the initial creation response and cannot be retrieved later.Input Parameters
true if the delivery method URL is repeatedly rejected by the server.Output
Create or update status page post
Create or update status page post
PAGERDUTY_CREATE_OR_UPDATE_STATUS_PAGE_POSTCreates a new post on a PagerDuty Status Page to communicate service status to users. Use this action to publish incident reports (for service disruptions) or maintenance announcements (for scheduled work). Each post includes a title, type, and one or more updates describing the current situation. You can specify which services are impacted, the severity level, whether to notify subscribers, and expected update frequency. For maintenance posts, include start and end times. For incident posts, these times are optional. This action is essential for transparent customer communication during service issues or planned work.Input Parameters
Output
Create or update status page postmortem
Create or update status page postmortem
PAGERDUTY_CREATE_OR_UPDATE_STATUS_PAGE_POSTMORTEMCreates or updates a postmortem for a specific status page post in PagerDuty. This endpoint allows you to add detailed analysis and insights about an incident after its resolution. The postmortem can include rich-text content and offers the option to notify subscribers. Use this when you need to provide a comprehensive review of an incident, its root causes, and lessons learned. It’s particularly useful for maintaining transparency and improving incident response processes. Note that the postmortem is limited to 10,000 characters and is always associated with an existing status page post.Input Parameters
Output
Create response play for incidents
Create response play for incidents
Create schedule overrides configuration
Create schedule overrides configuration
PAGERDUTY_CREATE_SCHEDULE_OVERRIDES_CONFIGURATIONCreates one or more overrides for a specific schedule in PagerDuty. This endpoint allows you to temporarily modify the on-call schedule by assigning different users for specific time periods. It’s useful for handling planned absences, shift swaps, or special coverage requirements without permanently altering the regular schedule. The overrides are applied to the schedule identified by the {id} parameter in the endpoint URL. Multiple overrides can be created in a single request, enabling efficient batch modifications to the schedule. Each override specifies a start time, end time, and the user who will be on call during that period. The endpoint should be used when temporary changes to the on-call rotation are needed. It does not modify the underlying schedule configuration.Input Parameters
Output
Create service event rule
Create service event rule
PAGERDUTY_CREATE_SERVICE_EVENT_RULECreates a legacy service event rule with conditions and actions for processing incoming events, including optional ordering and scheduling. PagerDuty recommends migrating Event Rules to Event Orchestration.Input Parameters
Output
Create statuspage subscription
Create statuspage subscription
PAGERDUTY_CREATE_STATUS_PAGE_SUBSCRIPTIONCreates a new subscription for a PagerDuty status page. This endpoint allows users to set up notifications for specific status pages or components within those pages. It’s used to keep subscribers informed about updates, incidents, or changes to the monitored services. The subscription can be configured for either email or webhook notifications, allowing for flexible integration with various notification systems. This tool should be used when setting up new monitoring or alert systems, or when adding new stakeholders who need to be kept informed about service status. It’s particularly useful for DevOps teams, IT managers, or customer support teams who need real-time updates on service health. Note that this endpoint only creates the subscription; it does not manage or trigger the actual notifications.Input Parameters
Output
Create status update template
Create status update template
PAGERDUTY_CREATE_STATUS_UPDATE_TEMPLATECreates a new status update template in PagerDuty for standardized incident notifications. Templates provide consistent, pre-formatted messages for stakeholder updates across email, SMS, push, and Slack. Supports dynamic variables like {{incident.title}}, {{incident.status}}, etc. Requires PagerDuty Business or Enterprise plan (returns 402 error otherwise). Only ‘status_update’ template type is currently supported. At minimum, provide a template name.Input Parameters
Output
Create user notification rule
Create user notification rule
PAGERDUTY_CREATE_USER_NOTIFICATION_RULECreates a new notification rule for a specific user in PagerDuty. This endpoint allows you to define how and when a user should be notified about assigned incidents. You can specify the delay before notification, the method of contact, and the urgency level of incidents that trigger this rule. This is particularly useful for customizing alert behaviors for different users based on their preferences or role within the organization. The rule created will be associated with the user identified by the provided ID in the URL path.Input Parameters
Output
Create user object
Create user object
PAGERDUTY_CREATE_USER_OBJECTCreates a new user in the PagerDuty system with the specified attributes. This endpoint should be used when onboarding new team members or adding users to your PagerDuty account. It allows you to set up essential user information, including name, email, role, and time zone preferences. The created user will have default contact methods and notification rules, which can be customized later. Note that some fields like teams, contact methods, and notification rules cannot be set during user creation and must be managed separately. The endpoint requires at minimum a name, email, and user type, with several optional fields for further customization.Input Parameters
Output
Create user status update notification rule
Create user status update notification rule
PAGERDUTY_CREATE_USER_STATUS_UPDATE_NOTIFICATION_RULECreates a new status update notification rule for a specific user in PagerDuty. This endpoint allows you to define how a user will be notified about incident status updates. It’s used to customize notification preferences for individual users, ensuring they receive timely updates through their preferred contact method. The rule specifies which contact method (email, phone, push notification, or SMS) should be used for sending status updates. This is particularly useful for tailoring notification strategies to match users’ roles and responsibilities within the incident management process.Input Parameters
Output
Create workflow integration connection
Create workflow integration connection
Delete account subscription by id
Delete account subscription by id
Delete a custom field for an incident type
Delete a custom field for an incident type
PAGERDUTY_DELETE_A_CUSTOM_FIELD_FOR_AN_INCIDENT_TYPEDeletes a custom field from the specified incident type.Input Parameters
Output
Delete addon by id
Delete addon by id
PAGERDUTY_DELETE_ADDON_BY_IDDeletes a specific add-on from the PagerDuty account using its unique identifier. This endpoint should be used when you want to remove an integration or extension that is no longer needed or active in your PagerDuty setup. It’s important to note that this action is irreversible, and once an add-on is deleted, it cannot be recovered without re-adding it. Use this endpoint with caution, as removing an add-on may impact any automated workflows or integrations that depend on it.Input Parameters
Output
Delete a field option for a custom field
Delete a field option for a custom field
PAGERDUTY_DELETE_A_FIELD_OPTION_FOR_A_CUSTOM_FIELDDeletes a specific selectable field option from a custom field on an incident type.Input Parameters
Output
Delete alert grouping setting
Delete alert grouping setting
PAGERDUTY_DELETE_ALERT_GROUPING_SETTINGThis endpoint allows you to delete specific alert grouping settings in PagerDuty. It is used to remove outdated or unnecessary configurations that determine how alerts are grouped into incidents. The deletion is permanent and cannot be undone, so it should be used with caution. This operation is particularly useful when updating your incident management strategy or cleaning up unused configurations to maintain an efficient alert grouping system. Note that deleting these settings may affect how future alerts are grouped, potentially impacting your team’s incident response workflow.Input Parameters
Output
Delete all oauth delegations
Delete all oauth delegations
PAGERDUTY_DELETE_ALL_OAUTH_DELEGATIONSDelete all OAuth delegations for a user based on the specified type. An OAuth delegation represents an instance of a user or account’s authorization to an app (via OAuth) to access their PagerDuty account. Common apps include the PagerDuty mobile app, Slack, Microsoft Teams, and third-party apps. Deleting an OAuth delegation will revoke that instance of an app’s access to that user or account. To grant access again, reauthorization/reauthentication may be required. Currently, this endpoint only supports deleting mobile app OAuth delegations for a given user. This is equivalent to signing users out of the PagerDuty mobile app. The deletion is processed synchronously and takes effect immediately. Scoped OAuth requires: oauth_delegations.writeInput Parameters
Output
Delete automation action by id
Delete automation action by id
PAGERDUTY_DELETE_AUTOMATION_ACTION_BY_IDDeletes a specific Automation Action from the PagerDuty system. This endpoint is used to permanently remove an Automation Action, which includes any associated scripts or jobs in Runbook Automation. It should be used when an Automation Action is no longer needed or has become obsolete. Once deleted, the action cannot be recovered, so use this endpoint with caution. This operation is typically performed by administrators or users with appropriate permissions to manage Automation Actions.Input Parameters
Output
Delete automation action service by id
Delete automation action service by id
PAGERDUTY_DELETE_AUTOMATION_ACTION_SERVICE_BY_IDThis endpoint removes a specific automation action from a particular service in PagerDuty. It is used to disassociate an automated workflow or action from a service, effectively stopping that action from being triggered for incidents related to the specified service. This operation is useful when you need to update your incident management workflow or when an automated action is no longer relevant for a specific service. It’s important to note that this endpoint only removes the association between the action and the service; it does not delete the automation action itself from the system. Use this endpoint with caution, as removing an automation action from a service will immediately affect the incident response process for that service.Input Parameters
Output
Delete automation actions runner by id
Delete automation actions runner by id
PAGERDUTY_DELETE_AUTOMATION_ACTIONS_RUNNER_BY_IDPermanently deletes an automation actions runner from PagerDuty. Automation runners execute automated tasks and workflows during incident response. Use this when a runner is no longer needed or needs replacement. WARNING: Deletion is irreversible and will affect all automation actions and schedules using this runner. Requires Automation Actions feature subscription. To use: First obtain the runner ID via list_automation_actions_runners or get_automation_action_runner_by_id, then call this endpoint with that ID.Input Parameters
Output
Delete business service by id
Delete business service by id
PAGERDUTY_DELETE_BUSINESS_SERVICE_BY_IDDeletes a specific business service from the PagerDuty system. This endpoint should be used when you want to permanently remove a business service that is no longer needed or relevant to your organization’s incident management structure. It’s important to note that this action is irreversible and will remove all associations between the deleted business service and any technical services or incidents. Use this endpoint with caution, as it may impact reporting and historical data related to the deleted business service. Before deletion, ensure that no active incidents or dependencies rely on this business service to avoid disruptions in your incident management workflow.Input Parameters
Output
Delete business service priority thresholds
Delete business service priority thresholds
PAGERDUTY_DELETE_BUSINESS_SERVICE_PRIORITY_THRESHOLDSDeletes the account-level global priority threshold for business services in PagerDuty. This endpoint removes the configured priority threshold that determines the minimum incident priority level required for incidents to impact business services. When a global threshold is set, only incidents at or above that priority level will affect business services. Use this action to remove the global threshold entirely, allowing incidents of any priority to impact business services (or reverting to default behavior). This operation is idempotent - it can be called even when no threshold is currently set. The action does not delete business services themselves, only the global priority threshold configuration. Note that this affects all business services across the account.Output
Delete cache variable for event
Delete cache variable for event
PAGERDUTY_DELETE_CACHE_VARIABLE_FOR_EVENTDeletes a specific cache variable associated with an event orchestration in PagerDuty. This endpoint is used to remove temporary data storage that was previously set up for use in event orchestration workflows. It should be used when you need to clean up or remove outdated cache variables that are no longer needed in your event management process. This operation is idempotent - attempting to delete a cache variable that doesn’t exist will return a successful response. The endpoint requires both the event orchestration ID and the specific cache variable ID to ensure precise removal of the intended data. Requirements: - Event Intelligence/Digital Operations plan OR PagerDuty AIOps add-on - Advanced Event Orchestration pricing tier - API token with event_orchestrations:write scope - User with Team Manager-level permissions or aboveInput Parameters
Output
Delete cache variable from service
Delete cache variable from service
PAGERDUTY_DELETE_CACHE_VARIABLE_FROM_SERVICEDeletes a cache variable from a service’s event orchestration. Cache variables store temporary data used in event orchestration workflows. This action permanently removes the specified cache variable. Returns HTTP 204 No Content on successful deletion. Use this when cleaning up obsolete cache variables or freeing resources. Note: This action cannot be undone.Input Parameters
Output
Delete custom field by field id
Delete custom field by field id
PAGERDUTY_DELETE_CUSTOM_FIELD_BY_FIELD_IDDeletes a legacy PagerDuty incident custom field by ID. A not-found response is treated as a successful no-op. DEPRECATED: PagerDuty recommends the custom field endpoints under Incident Types instead.Input Parameters
Output
Delete escalation policy by id
Delete escalation policy by id
PAGERDUTY_DELETE_ESCALATION_POLICY_BY_IDPermanently removes a specific escalation policy from the PagerDuty system. This endpoint should be used when an escalation policy is no longer needed or has become obsolete. Once deleted, the escalation policy cannot be recovered, and any services or incidents associated with it will need to be reassigned. Exercise caution when using this endpoint, as it will impact incident routing and may affect your team’s ability to respond to alerts if not properly managed. It’s recommended to review and update any dependent services before deleting an escalation policy.Input Parameters
Output
Delete event by id
Delete event by id
PAGERDUTY_DELETE_EVENT_BY_IDDeletes a specific Event Orchestration from the PagerDuty system. This endpoint should be used when you want to permanently remove an Event Orchestration configuration, including all its associated rules and routing logic. It’s important to note that this action is irreversible, and once an Event Orchestration is deleted, it cannot be recovered. Before using this endpoint, ensure that the Event Orchestration is no longer needed and that its deletion won’t disrupt any critical event routing or automation processes in your PagerDuty setup. This endpoint is particularly useful during cleanup operations or when restructuring your event management workflow.Input Parameters
Output
Delete extension by id
Delete extension by id
PAGERDUTY_DELETE_EXTENSION_BY_IDDeletes a specific extension from the PagerDuty service. This endpoint should be used when you want to remove an additional feature or integration that has been previously added to your PagerDuty account. It’s particularly useful for cleaning up obsolete integrations or disabling unwanted functionalities. Note that deleting an extension is permanent and cannot be undone, so use this endpoint with caution. This operation doesn’t affect the core PagerDuty service, only the specified extension.Input Parameters
Output
Delete field option
Delete field option
PAGERDUTY_DELETE_FIELD_OPTIONPermanently deletes a field option from a custom incident field. For example, removes “Medium” from a Priority field with options “Critical”, “High”, “Medium”, “Low”. Prerequisites: Use PAGERDUTY_RETRIEVE_INCIDENT_CUSTOM_FIELDS with include=‘field_options’ to get valid field_id and field_option_id values. Requires OAuth scope: custom_fields.write Warning: This is IRREVERSIBLE and may impact existing incidents, reports, and automations that use this option value. Returns HTTP 204 No Content on success.Input Parameters
Output
Delete incident workflow by id
Delete incident workflow by id
PAGERDUTY_DELETE_INCIDENT_WORKFLOW_BY_IDDeletes a specific incident workflow from the PagerDuty system. This endpoint should be used when you want to permanently remove a customized sequence of automated actions and triggers associated with incident management. It’s important to note that this action is irreversible, and once deleted, the workflow cannot be recovered. Use this endpoint with caution, ensuring that the workflow is no longer needed before deletion. This operation helps in maintaining a clean and relevant set of incident workflows, improving overall incident management efficiency.Input Parameters
Output
Delete incident workflow trigger by id
Delete incident workflow trigger by id
PAGERDUTY_DELETE_INCIDENT_WORKFLOW_TRIGGER_BY_IDDeletes an incident workflow trigger by ID. A 404 response is treated as success, so a successful result does not establish that a trigger was deleted by this request.Input Parameters
Output
Delete incident workflow trigger service
Delete incident workflow trigger service
PAGERDUTY_DELETE_INCIDENT_WORKFLOW_TRIGGER_SERVICERemoves a service from an incident workflow trigger in PagerDuty. This action disassociates a specific service from a trigger, preventing incidents from that service from automatically activating the workflow. Use this when you need to modify which services trigger automated incident responses. Important Notes: - The trigger and service must both exist and be currently associated - Returns 204 No Content on success with an empty response body - Returns 404 Not Found if the trigger or service association doesn’t exist - This operation is immediate and affects future incident workflow executions - Cannot be undone - you’ll need to re-add the service if removed by mistake Common Use Cases: - Updating which services participate in automated incident workflows - Removing a service from incident automation during maintenance - Adjusting workflow scope when service responsibilities change Required Permissions: incident_workflows:write OAuth scopeInput Parameters
Output
Delete integration from event orchestration
Delete integration from event orchestration
PAGERDUTY_DELETE_INTEGRATION_FROM_EVENT_ORCHESTRATIONRemoves a specific integration from an event orchestration in PagerDuty. This endpoint is used to disconnect a particular tool or service from the event orchestration setup, effectively stopping it from triggering or modifying incidents within that orchestration. It’s particularly useful when you need to retire an old integration or reconfigure your event management workflow. Be cautious when using this endpoint, as deleting an integration is irreversible and may impact your incident response processes if not properly planned.Input Parameters
Output
Delete maintenance window by id
Delete maintenance window by id
Delete oncall handoff notification rule
Delete oncall handoff notification rule
PAGERDUTY_DELETE_ONCALL_HANDOFF_NOTIFICATION_RULEThis endpoint deletes a specific on-call handoff notification rule for a given user in PagerDuty. It is used to remove custom notification settings for when on-call responsibilities are transferred between team members. This operation is permanent and cannot be undone, so it should be used with caution. The endpoint is particularly useful for maintaining clean and up-to-date notification configurations, especially when certain handoff rules are no longer needed or have become obsolete. It requires both the user’s ID and the specific rule ID to ensure precise targeting of the rule to be deleted.Input Parameters
Output
Delete post from status page
Delete post from status page
PAGERDUTY_DELETE_POST_FROM_STATUS_PAGEThis endpoint deletes a specific post from a PagerDuty status page. It is used to remove outdated or irrelevant information from a status page, helping to maintain clear and accurate communication with users about service status. The operation is irreversible, so it should be used with caution. This endpoint is particularly useful for cleaning up resolved incidents or removing erroneous updates. It does not provide any ability to modify or retrieve post content; it only removes the specified post entirely from the status page.Input Parameters
Output
Delete post update by id
Delete post update by id
PAGERDUTY_DELETE_POST_UPDATE_BY_IDThis endpoint deletes a specific post update from a status page post in PagerDuty. It allows users to remove outdated or incorrect information from a status page, ensuring that only relevant and accurate updates are displayed. The endpoint should be used when an organization needs to retract or remove a previously published update on their status page. It’s important to note that this action is permanent and cannot be undone, so it should be used with caution. This endpoint is particularly useful for maintaining the accuracy and relevance of status page communications during incident management or scheduled maintenance periods.Input Parameters
Output
Delete response play
Delete response play
Delete rule from ruleset by id
Delete rule from ruleset by id
Delete ruleset by id
Delete ruleset by id
Delete runner team association
Delete runner team association
PAGERDUTY_DELETE_RUNNER_TEAM_ASSOCIATIONThis endpoint removes a team’s association from a specific Automation Action runner in PagerDuty. It is used to revoke a team’s access to execute or manage tasks on a particular runner. The operation is permanent and should be used when you no longer want a team to have access to the runner’s capabilities. This action is typically performed for security reasons, organizational changes, or when refining access control within your PagerDuty environment. Note that this endpoint only removes the association; it does not delete the runner or the team themselves.Input Parameters
Output
Delete schedule by id
Delete schedule by id
Delete schedule override by id
Delete schedule override by id
PAGERDUTY_DELETE_SCHEDULE_OVERRIDE_BY_IDThis endpoint deletes a specific override from a PagerDuty schedule. It allows users to remove temporary changes made to the regular schedule, reverting it back to its original state. This operation is useful for canceling previously set overrides that are no longer needed, such as temporary shift changes or one-time schedule adjustments. The deletion is permanent and cannot be undone, so it should be used with caution. This endpoint is particularly helpful for maintaining schedule integrity and ensuring that only current and relevant overrides remain active.Input Parameters
Output
Delete service by id
Delete service by id
PAGERDUTY_DELETE_SERVICE_BY_IDDeletes a specific service from the PagerDuty account. This endpoint should be used when you need to permanently remove a service that is no longer required or active. It’s important to note that this operation is irreversible and will delete all associated incidents, alerts, and integrations for the specified service. Use this endpoint with caution, as it can impact your incident management workflow. Before deletion, ensure that the service is no longer needed and that all relevant data has been backed up if necessary.Input Parameters
Output
Delete service rule by id
Delete service rule by id
PAGERDUTY_DELETE_SERVICE_RULE_BY_IDDeletes a specific rule from a PagerDuty service. This endpoint is used to permanently remove a rule that defines conditions for incident creation or automation within a particular service. It should be used when you need to eliminate an outdated, incorrect, or no longer needed rule from your service configuration. The operation cannot be undone, so use it with caution. This endpoint does not return the deleted rule’s details; it only confirms the successful deletion. PagerDuty no longer permits creating Rulesets/Event Rules, but this endpoint remains available for deleting an existing Service Event Rule. PagerDuty recommends migrating existing Event Rules to Event Orchestration.Input Parameters
Output
Delete status page postmortem
Delete status page postmortem
PAGERDUTY_DELETE_STATUS_PAGE_POSTMORTEMThis endpoint allows you to delete a postmortem associated with a specific post on a PagerDuty status page. It is used to remove the detailed analysis and lessons learned from an incident after it has been resolved and documented. This action is permanent and should be used with caution, as it will remove valuable information about past incidents. The endpoint is particularly useful for maintaining the relevance of status page content, removing outdated postmortems, or correcting information that should not have been published. It’s important to note that this operation cannot be undone, so it’s recommended to have a backup of the postmortem content before deletion if retention of this information is necessary for internal records.Input Parameters
Output
Delete status update notification rule
Delete status update notification rule
PAGERDUTY_DELETE_STATUS_UPDATE_NOTIFICATION_RULEDeletes a specific status update notification rule associated with a user in the PagerDuty system. This endpoint allows administrators or users with appropriate permissions to remove custom notification rules for status updates, helping to manage and streamline the user’s notification preferences. It should be used when a particular status update notification rule is no longer needed or requires removal from the user’s settings. The operation is irreversible, so caution should be exercised when invoking this endpoint. It’s important to note that this endpoint only removes the specified rule and does not affect other notification rules or user settings.Input Parameters
Output
Delete subscription from status page
Delete subscription from status page
PAGERDUTY_DELETE_SUBSCRIPTION_FROM_STATUS_PAGEDeletes a specific subscription associated with a PagerDuty status page. This endpoint is used to remove a subscription, effectively stopping notifications or updates related to the status page for the subscribed entity. It should be used when a user or system no longer needs to receive alerts or information about a particular status page. This operation is permanent and cannot be undone, so it should be used with caution. The endpoint requires both the status page ID and the specific subscription ID to ensure precise removal of the intended subscription.Input Parameters
Output
Delete tag by id
Delete tag by id
PAGERDUTY_DELETE_TAG_BY_IDDeletes a specific tag from the PagerDuty system based on its unique identifier. This endpoint should be used when you need to remove a tag that is no longer relevant or necessary for categorizing incidents, services, or other resources in PagerDuty. It’s important to note that deleting a tag will remove it from all associated resources, which could impact filtering and organization within the PagerDuty platform. This operation is irreversible, so it should be used with caution. The endpoint does not return the deleted tag’s information, so if you need to reference the tag details, you should retrieve them before deletion.Input Parameters
Output
Delete team by id
Delete team by id
PAGERDUTY_DELETE_TEAM_BY_IDDeletes a team from PagerDuty by its ID. This is a permanent, irreversible operation. Required: id (team ID to delete, e.g., ‘PXXXXXX’) Optional: reassignment_team (team ID to reassign unresolved incidents to) Important considerations: - Users in the team are NOT deleted, only the team structure is removed - Unresolved incidents can be reassigned to another team or made account-level - Associated schedules and escalation policies should be handled separately - This action cannot be undone Use cases: - Removing obsolete or unused teams - Consolidating team structures - Cleaning up after organizational changes Returns: HTTP 204 No Content on success (empty data dictionary)Input Parameters
Output
Delete team escalation policy
Delete team escalation policy
Delete team from automation action
Delete team from automation action
PAGERDUTY_DELETE_TEAM_FROM_AUTOMATION_ACTIONThis endpoint removes a specific team’s access to an Automation Action in PagerDuty. It’s used to revoke permissions when a team no longer needs to use or should not have access to a particular Automation Action. This operation is permanent and cannot be undone through this endpoint. It should be used carefully, as it will immediately prevent the specified team from executing the Automation Action. This endpoint is particularly useful for managing access control and ensuring that only authorized teams can perform certain automated tasks.Input Parameters
Output
Delete template by id
Delete template by id
PAGERDUTY_DELETE_TEMPLATE_BY_IDDeletes a specific template from the PagerDuty account. This endpoint is used to permanently remove a template configuration, which can be useful for cleaning up outdated or unnecessary incident response plans. Once deleted, the template cannot be recovered, so use this operation with caution. It should be used when you no longer need a particular template for incident management or when you want to replace an old template with a new one. This operation does not affect any ongoing incidents that may have been created using the template.Input Parameters
Output
Delete user by id
Delete user by id
PAGERDUTY_DELETE_USER_BY_IDDeletes a specific user from the PagerDuty system using their unique identifier. This endpoint should be used when you need to permanently remove a user’s account, such as when an employee leaves the organization or no longer requires access to the incident management system. It’s important to note that deleting a user is irreversible and will remove all associated data, including their contact information, notification rules, and incident history. Before deletion, ensure that any ongoing incidents or schedules involving this user are reassigned to prevent disruptions in incident management workflows. This operation cannot be undone, so it should be used with caution and only when absolutely necessary.Input Parameters
Output
Delete user contact method
Delete user contact method
PAGERDUTY_DELETE_USER_CONTACT_METHODDeletes a specific contact method associated with a user in PagerDuty. This endpoint should be used when you need to remove an outdated or unnecessary contact method from a user’s profile. It permanently removes the specified contact method, so use with caution. This operation cannot be undone. Ensure that the user has at least one remaining contact method after deletion to maintain their ability to receive notifications. This endpoint is particularly useful for maintaining up-to-date user profiles and streamlining communication channels.Input Parameters
Output
Delete user from team by id
Delete user from team by id
PAGERDUTY_DELETE_USER_FROM_TEAM_BY_IDThis endpoint removes a specific user from a designated team within the PagerDuty incident management platform. It is used to update team compositions by disassociating a user from a particular team, which affects the user’s involvement in that team’s incident responses and escalation policies. This operation is particularly useful when restructuring teams, offboarding employees, or adjusting user roles and responsibilities. The endpoint requires both the team’s unique identifier and the user’s unique identifier to ensure precise user-team disassociation. It’s important to note that this action does not delete the user from the PagerDuty account; it only removes their association with the specified team. Use this endpoint cautiously, as it immediately affects the user’s ability to receive and respond to incidents related to the team.Input Parameters
Output
Delete user notification rule
Delete user notification rule
PAGERDUTY_DELETE_USER_NOTIFICATION_RULEDeletes a specific notification rule for a user in PagerDuty. This endpoint allows administrators or users with appropriate permissions to remove custom notification rules, modifying how and when a user receives alerts about incidents. It should be used when updating a user’s notification preferences or when a specific notification rule is no longer needed. The deletion is permanent and cannot be undone, so caution should be exercised when using this endpoint. It’s important to note that this action does not affect the user’s default notification rules or their overall ability to receive notifications; it only removes the specified custom rule.Input Parameters
Output
Delete all user sessions
Delete all user sessions
Delete user session by type
Delete user session by type
PAGERDUTY_DELETE_USER_SESSION_BY_TYPEDeletes a specific PagerDuty user session identified by user ID, session type and session ID. The user sessions deletion endpoint is deprecated.Input Parameters
Output
Delete webhook subscription by id
Delete webhook subscription by id
PAGERDUTY_DELETE_WEBHOOK_SUBSCRIPTION_BY_IDDeletes a specific webhook subscription from your PagerDuty account. This endpoint should be used when you want to stop receiving notifications for a particular webhook subscription, such as when the integration is no longer needed or when updating your notification preferences. Once deleted, the webhook subscription will immediately cease to function, and you will no longer receive notifications for the events it was configured to monitor. This action is irreversible, so use it with caution. If you need to temporarily disable notifications, consider using other management options instead of deletion.Input Parameters
Output
Delete workflow integration connection
Delete workflow integration connection
PAGERDUTY_DELETE_WORKFLOW_INTEGRATION_CONNECTIONDeletes a specific workflow integration connection from PagerDuty. Workflow integration connections enable PagerDuty workflows to interact with external services like AWS, Azure, Slack, and other platforms. This endpoint permanently removes a connection, which means any workflows using this connection will no longer be able to execute actions through it. This action is irreversible and cannot be undone. Before deleting a connection, ensure that no active workflows depend on it to avoid disruptions in your automation processes. Scoped OAuth requires: workflow_integrations:connections.writeInput Parameters
Output
Disassociate service dependencies
Disassociate service dependencies
PAGERDUTY_DISASSOCIATE_SERVICE_DEPENDENCIESDisassociates (removes) service dependencies in PagerDuty by deleting specified relationships between supporting and dependent services. This endpoint allows for efficient removal of multiple service dependencies in a single API call. Use this action when you need to: - Remove obsolete or incorrect service dependency relationships - Restructure service hierarchies by breaking existing dependencies - Clean up service dependency mappings during refactoring - Update the service topology by removing outdated connections Important: This operation is irreversible and will immediately affect the dependency structure. The response returns the removed relationships with their IDs. Service types are automatically normalized (e.g., ‘service_reference’ becomes ‘technical_service_reference’ in the response).Input Parameters
Output
Edit webhook subscription by id
Edit webhook subscription by id
PAGERDUTY_EDIT_WEBHOOK_SUBSCRIPTION_BY_IDEdit an existing webhook subscription in PagerDuty to modify its configuration. This action allows you to: - Update the list of incident event types the webhook subscribes to - Change the subscription description - Enable or disable the webhook (active status) - Modify filter criteria (service/team/account scope) - though filter type changes may be restricted Use cases: - Adjust which incident events trigger webhook notifications as your needs evolve - Temporarily disable a webhook without deleting it - Update descriptions to reflect changes in webhook purpose - Fine-tune event filtering for specific services or teams Important notes: - All update parameters are optional - only include fields you want to change - The webhook’s delivery method (URL, headers) cannot be changed via this endpoint - Changing filter_type after creation may not be supported by the API - The response includes the complete updated webhook configuration - The secret for payload verification is not returned in update responses (null)Input Parameters
Output
Enable extension by id
Enable extension by id
PAGERDUTY_ENABLE_EXTENSION_BY_IDEnables a temporarily disabled extension in PagerDuty. Extensions (such as webhooks and custom integrations) can be automatically disabled by PagerDuty when there are repeated delivery failures, timeouts, or other issues. This endpoint reactivates such extensions after the underlying issues have been resolved. Common reasons extensions are disabled: - Webhook endpoint returns non-2xx status codes repeatedly - Webhook endpoint times out or responds too slowly - 3xx redirects from the webhook URL - Authentication failures at the webhook endpoint The endpoint is idempotent and can be called on already-enabled extensions without error. After enabling, verify that the underlying issue (e.g., webhook endpoint availability, correct URL, proper authentication) has been fixed to prevent the extension from being disabled again. The extension is identified by its unique ID.Input Parameters
Output
Enable webhook subscription by id
Enable webhook subscription by id
PAGERDUTY_ENABLE_WEBHOOK_SUBSCRIPTION_BY_IDActivates a specific webhook subscription in PagerDuty, enabling the system to send notifications for the events configured in that subscription. This endpoint should be used when you want to start receiving webhook notifications after creating or previously disabling a subscription. It’s particularly useful for managing notification flows dynamically, such as during maintenance periods or when integrating new systems. Note that this operation only affects the specified subscription and does not modify its configuration or event filters.Input Parameters
Output
Execute response play by id
Execute response play by id
PAGERDUTY_EXECUTE_RESPONSE_PLAY_BY_IDExecutes a predefined Response Play for a specific incident in PagerDuty. This endpoint allows you to trigger a sequence of automated actions designed to manage and respond to the given incident. It’s useful for standardizing and streamlining your incident response process, ensuring consistent handling of similar incidents. The endpoint requires you to specify the incident for which the Response Play should be run, using the incident’s unique identifier. Note that the Response Play itself is identified by the ID in the URL path, not in the request body. DEPRECATED: Response Plays are EOL. On accounts with Incident Workflows enabled this always fails; use the Incident Workflows actions instead.Input Parameters
Output
Fetch cache variable for event orchestration
Fetch cache variable for event orchestration
PAGERDUTY_FETCH_CACHE_VARIABLE_FOR_EVENT_ORCHESTRATIONRetrieves a specific cache variable in a PagerDuty event orchestration, including its ID, name, configuration, conditions, and disabled status. Use it to inspect settings or debug orchestration logic.Input Parameters
Output
Fetch custom incident field by id
Fetch custom incident field by id
PAGERDUTY_FETCH_CUSTOM_INCIDENT_FIELD_BY_IDRetrieves detailed information about a specific custom field associated with incidents in PagerDuty. This endpoint allows users to fetch the configuration and attributes of a custom field by providing its unique identifier. It’s useful for verifying custom field settings, understanding the structure of additional data points on incidents, or preparing to update a custom field. The endpoint should be used when detailed information about a particular custom field is needed, such as its name, data type, or any predefined options. Note that this endpoint only provides information about the custom field itself, not the values assigned to incidents.Input Parameters
Output
Fetch escalation polices list
Fetch escalation polices list
PAGERDUTY_FETCH_ESCALATION_POLICES_LISTLists PagerDuty escalation policies with their escalation rules. Results can be filtered and paginated using limit and offset.Input Parameters
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.teams ability to use this parameter.Output
Fetch event orchestrations
Fetch event orchestrations
PAGERDUTY_FETCH_EVENT_ORCHESTRATIONSLists PagerDuty Event Orchestrations with pagination and sorting, returning orchestration metadata and integration references.Input Parameters
Output
Fetch incident analytics by id
Fetch incident analytics by id
PAGERDUTY_FETCH_INCIDENT_ANALYTICS_BY_IDRetrieves raw analytics data for a specific incident in PagerDuty. This endpoint provides unprocessed incident information, allowing for detailed analysis and custom reporting. It should be used when in-depth, granular data about a particular incident is needed, such as for investigating complex issues or generating custom analytics. The endpoint returns comprehensive incident details, which may include timestamps, status changes, assignee information, and other relevant metrics. However, it does not provide pre-analyzed or aggregated data; users will need to process the raw data themselves for specific insights.Input Parameters
Output
Fetch incident list
Fetch incident list
PAGERDUTY_FETCH_INCIDENT_LISTRetrieves a list of incidents from PagerDuty based on specified criteria. This endpoint allows users to fetch multiple incidents, making it useful for incident management, reporting, and analysis. It supports filtering by status and date range, as well as pagination for handling large result sets. The endpoint is particularly valuable for obtaining an overview of recent or ongoing incidents, tracking incident trends, or integrating PagerDuty incident data into external systems or dashboards. Note that while this endpoint provides a summary of incidents, it may not include full details for each incident; separate API calls might be necessary to fetch comprehensive information for individual incidents.Input Parameters
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.teams ability to use this parameter.urgencies ability to use this filter.Output
Fetch outlier incident by id
Fetch outlier incident by id
PAGERDUTY_FETCH_OUTLIER_INCIDENT_BY_IDRetrieves outlier information for a specific PagerDuty incident, including its occurrence pattern and frequency on the service. Outlier classifications include frequent, rare, and anomalous incidents.Input Parameters
Output
Fetch post update status
Fetch post update status
PAGERDUTY_FETCH_POST_UPDATE_STATUSRetrieves detailed information about a specific post update on a PagerDuty status page. This endpoint allows you to fetch the content and metadata of a particular update made to a post, providing insight into the chronological changes and communications related to an incident or maintenance event. Use this when you need to review or display the exact content of a specific update, such as for auditing purposes or to provide detailed information to stakeholders. The endpoint requires the unique identifiers for the status page, the post, and the specific update, ensuring precise retrieval of the desired information. It’s particularly useful for tracking the evolution of an incident’s communication or for analyzing the effectiveness of status updates over time.Input Parameters
Output
Fetch priorities list
Fetch priorities list
PAGERDUTY_FETCH_PRIORITIES_LISTRetrieves a list of existing priorities in the PagerDuty system, ordered from most severe to least severe. This endpoint should be used when you need to obtain information about the current priority levels configured in your PagerDuty account. It’s particularly useful for integrations that need to reference or display priority information, or for administrators who want to review the existing priority structure. The endpoint provides a read-only view of priorities and does not allow for creation, modification, or deletion of priority levels. Keep in mind that this API call is subject to rate limiting, so it should not be called excessively in short periods.Input Parameters
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.Output
Fetch runner teams integration
Fetch runner teams integration
PAGERDUTY_FETCH_RUNNER_TEAMS_INTEGRATIONRetrieves a list of teams associated with a specific Automation Action Runner in PagerDuty. This endpoint allows users to identify which teams have access to or are responsible for a particular runner, facilitating better management and organization of automation resources. It’s particularly useful for administrators who need to audit runner permissions or when planning to modify team access to automation capabilities. The endpoint returns team information related to the specified runner only and does not provide details about the runner itself or its automation actions.Input Parameters
Output
Fetch status pages
Fetch status pages
PAGERDUTY_FETCH_STATUS_PAGESLists PagerDuty status pages, optionally filtering by public or private type. The response may be paginated; the tool makes one request.Input Parameters
Output
Fetch user contact method
Fetch user contact method
PAGERDUTY_FETCH_USER_CONTACT_METHODRetrieves detailed information about a specific contact method for a particular user in PagerDuty. This endpoint allows you to fetch the configuration and settings of a single contact method, such as an email address, phone number, or push notification settings, associated with a user’s account. It’s useful for verifying or auditing user contact information, or when you need to display or update a specific contact method. The endpoint requires both the user ID and the contact method ID to pinpoint the exact resource. It does not modify any data and is safe for frequent calls, but should be used judiciously in high-volume scenarios to avoid hitting rate limits.Input Parameters
Output
Fetch vendor list
Fetch vendor list
PAGERDUTY_FETCH_VENDOR_LISTRetrieves a list of vendors or third-party integrations available in the PagerDuty platform. This endpoint allows users to access information about various services and tools that can be integrated with PagerDuty for enhanced incident management and alerting capabilities. Use this endpoint when you need to explore or review the available integrations, such as monitoring tools, ticketing systems, or communication platforms. The response likely includes details such as vendor names, integration types, and possibly configuration options. Note that this endpoint does not provide real-time status of integrations or perform any actions on the integrations themselves.Input Parameters
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.Output
Filter and aggregate incident metrics
Filter and aggregate incident metrics
PAGERDUTY_FILTER_AND_AGGREGATE_INCIDENT_METRICSAnalyzes and aggregates incident metrics across teams in PagerDuty, allowing for detailed filtering and customization of results. This endpoint is used to gain insights into incident patterns, team performance, and overall operational efficiency. It provides flexible options for data selection, time range specification, and result presentation, making it valuable for generating reports, identifying trends, and optimizing incident management processes. The endpoint is particularly useful for operational reviews, team performance assessments, and strategic planning in incident response.Input Parameters
Output
Get addons list
Get addons list
PAGERDUTY_GET_ADDONS_LISTRetrieves a list of all addons associated with the PagerDuty account. This endpoint allows users to view the additional features or integrations that have been added to enhance the platform’s capabilities. It provides an overview of the current addons, which can include third-party services or custom extensions that extend the functionality of the core PagerDuty system. This endpoint is useful for auditing the account’s current addons, planning for potential new integrations, or managing existing ones. Note that this endpoint only returns basic information about the addons and may not include detailed configuration settings for each addon.Input Parameters
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.Output
Get a field option on a custom field
Get a field option on a custom field
PAGERDUTY_GET_A_FIELD_OPTION_ON_A_CUSTOM_FIELDRetrieves a specific field option from a custom field on an incident type, including its value, data type, and other metadata.Input Parameters
Output
Get aggregated pd advance usage data
Get aggregated pd advance usage data
PAGERDUTY_GET_AGGREGATED_PD_ADVANCE_USAGE_DATAProvides aggregated metrics for the usage of PD Advance. {/* theme: info */} > Note: Analytics data is updated periodically. It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: analytics.writeInput Parameters
Output
Get alert grouping settings
Get alert grouping settings
PAGERDUTY_GET_ALERT_GROUPING_SETTINGSLists all alert grouping settings configured in your PagerDuty account. Alert grouping settings control how multiple related alerts are automatically combined into a single incident, reducing noise and improving incident management. This endpoint returns settings including: - Grouping types: intelligent (ML-based), content_based, time-based, or content_based_intelligent - Configuration details: time windows, grouping fields (iag_fields), and other parameters - Associated services: which services each setting applies to Use this action to: - Audit current alert grouping configurations across your account - Discover which services have specific grouping rules applied - Retrieve setting IDs for use with update or delete operations - Understand how alerts are being consolidated in your incident workflow The response can be filtered by service IDs and supports pagination for accounts with many settings. Note that this returns configured settings, not real-time grouping status of active incidents.Input Parameters
Output
Get alerts by incident id
Get alerts by incident id
PAGERDUTY_GET_ALERTS_BY_INCIDENT_IDLists alerts associated with a PagerDuty incident, with pagination and optional status or alert-key filtering. It can include related service, first trigger log entry, or incident details.Input Parameters
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.Output
Get analytics metrics incidents all
Get analytics metrics incidents all
PAGERDUTY_GET_ANALYTICS_METRICS_INCIDENTS_ALLRetrieves aggregated incident analytics data for all incidents in PagerDuty. Use when you need comprehensive incident metrics across teams, services, and escalation policies.Input Parameters
Output
Get analytics metrics users all
Get analytics metrics users all
PAGERDUTY_GET_ANALYTICS_METRICS_USERS_ALLGet aggregated metrics for all users across the account. Returns user adoption and engagement metrics including mobile app downloads, escalation policy assignments, sign-up rates, and notification method configuration. Use when analyzing user adoption patterns, identifying users who need onboarding support, or generating reports on team readiness and engagement.Input Parameters
Output
Get analytics raw incidents responses
Get analytics raw incidents responses
Get analytics raw users
Get analytics raw users
PAGERDUTY_GET_ANALYTICS_RAW_USERSGet raw user analytics data from PagerDuty. Use when you need detailed user activity and configuration metrics for analysis and reporting.Input Parameters
Output
Get an incident type
Get an incident type
PAGERDUTY_GET_AN_INCIDENT_TYPERetrieves an incident type by ID or name for categorizing PagerDuty incidents, such as security, major, or fraud incidents. Scoped OAuth requires incident_types.read.Input Parameters
Output
Get an incident type custom field
Get an incident type custom field
PAGERDUTY_GET_AN_INCIDENT_TYPE_CUSTOM_FIELDGets a custom field for a PagerDuty incident type, optionally including its predefined field options. Scoped OAuth requires custom_fields.read.Input Parameters
Output
Get incident workflow trigger
Get incident workflow trigger
PAGERDUTY_GET_A_TRIGGERRetrieves details of a specific incident workflow trigger by ID. Incident workflow triggers define when and how workflows are activated - either automatically based on conditions (conditional), manually by responders (manual), or for specific incident types (incident_type). The response includes the trigger type, associated workflow, services, conditions, and permissions. This is useful for understanding workflow automation configuration and debugging workflow execution. Requires the incident_workflows.read OAuth scope.Input Parameters
Output
Get audit records
Get audit records
PAGERDUTY_GET_AUDIT_RECORDSRetrieves a list of audit records from the PagerDuty system. This endpoint allows users to access logs of configuration changes made to PagerDuty resources, such as account objects. The records are sorted by execution time, with the newest records appearing first. This tool is particularly useful for tracking and reviewing changes, conducting security audits, or generating reports on system modifications. It provides a comprehensive view of who made what changes and when, enhancing transparency and accountability within the organization. The endpoint supports pagination and date range filtering to manage large volumes of audit data effectively.Input Parameters
next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.Output
Get automation action by id
Get automation action by id
PAGERDUTY_GET_AUTOMATION_ACTION_BY_IDRetrieves detailed information about a specific automation action in PagerDuty’s incident management platform. This endpoint allows users to fetch the configuration and attributes of a predefined automation action by its unique identifier. It’s particularly useful when you need to review or audit the settings of an existing automation action, such as its triggers, conditions, or associated workflows. The endpoint should be used when detailed information about a single automation action is required, rather than for listing multiple actions. Note that this endpoint only provides read access to the automation action details and cannot be used to modify the action.Input Parameters
Output
Get automation action runner by id
Get automation action runner by id
PAGERDUTY_GET_AUTOMATION_ACTION_RUNNER_BY_IDRetrieves detailed information about a specific Automation Action Runner in PagerDuty. This endpoint allows users to fetch the configuration, status, and other relevant details of a Runner by providing its unique identifier. It’s particularly useful for monitoring the health and settings of individual Runners, which are crucial components in PagerDuty’s automated incident response system. This tool should be used when you need to inspect or verify the properties of a specific Runner, such as its connection status, associated scripts, or execution environment. It does not modify the Runner’s configuration or trigger any actions; it’s purely for information retrieval.Input Parameters
Output
Get automation actions runners
Get automation actions runners
PAGERDUTY_GET_AUTOMATION_ACTIONS_RUNNERSLists all automation action runners in your PagerDuty account. Runners are the execution environments that perform automation actions during incident response. Each runner can be a Runbook Automation instance or a Sidecar runner. This endpoint returns details about each runner including its type, name, description, connection status (last_seen timestamp), and optionally the automation actions associated with it. Use this to monitor runner health, audit runner configurations, or select appropriate runners for automation workflows. Supports filtering by name and pagination for large result sets. Note: This endpoint requires PagerDuty Automation Actions license/entitlement.Input Parameters
Output
Get automation action team by team id
Get automation action team by team id
PAGERDUTY_GET_AUTOMATION_ACTION_TEAM_BY_TEAM_IDRetrieves detailed information about a specific team’s association with an automation action in PagerDuty. This endpoint returns the details of how a particular team is linked to an automation action, which is useful for auditing access control, managing team permissions, and understanding which teams can execute specific automation actions. Use this endpoint when you need to verify or inspect the relationship between a specific team and an automation action, or when troubleshooting team-specific automation access and permissions. The response includes information about the team-action association that was created via the associate team endpoint.Input Parameters
Output
Get business services impacts
Get business services impacts
PAGERDUTY_GET_BUSINESS_SERVICES_IMPACTSLists business services sorted by impacted status, with impacted services first. Results can be filtered by business service IDs, and the response indicates whether more records remain.Input Parameters
Output
Get business services priority thresholds
Get business services priority thresholds
Get business service subscribers by id
Get business service subscribers by id
PAGERDUTY_GET_BUSINESS_SERVICE_SUBSCRIBERS_BY_IDRetrieves a page of subscribers for a specific PagerDuty business service, including users or teams configured to receive notifications. The response indicates whether more subscribers remain.Input Parameters
Output
Get cache variable by id
Get cache variable by id
PAGERDUTY_GET_CACHE_VARIABLE_BY_IDRetrieves detailed information about a specific cache variable associated with a particular service within an event orchestration in PagerDuty. This endpoint allows you to access the current state and configuration of a cache variable, which can be crucial for understanding and troubleshooting event orchestration workflows. Use this when you need to inspect or verify the settings of a cache variable for a given service, such as during debugging or auditing processes. The endpoint provides read-only access and does not allow modification of the cache variable. Keep in mind that the response will only include information about the specified cache variable and will not provide a comprehensive view of all variables or the entire event orchestration configuration.Input Parameters
Output
Get cache variables for service
Get cache variables for service
PAGERDUTY_GET_CACHE_VARIABLES_FOR_SERVICELists all cache variables configured for a Service Event Orchestration. Cache variables store dynamic event data that can be used in service-level routing and automation workflows. Returns detailed configurations including variable types (recent_value, trigger_event_count, or external_data), conditions for updates, enabled/disabled state, and audit metadata (created/updated timestamps and user references). Use cases: - Audit cache variable configurations for a service - Debug event processing and orchestration logic - Export service orchestration setup for documentation or backup - Verify cache variable states before making changes Requirements: - PagerDuty AIOps add-on or Advanced Event Orchestration tier - event_orchestrations:read scope - Team Manager or higher permissions - Service must have Event Orchestration enabled Note: Returns an empty array if no cache variables exist for the service orchestration. Each service orchestration can have up to 100 cache variables.Input Parameters
Output
Get escalation policy by id
Get escalation policy by id
PAGERDUTY_GET_ESCALATION_POLICY_BY_IDRetrieves detailed information about a specific escalation policy in PagerDuty. This endpoint allows you to fetch the complete configuration of an escalation policy, including its name, description, escalation rules, and associated services. Use this when you need to review or audit an existing escalation policy’s setup. It’s particularly useful for understanding how incidents are being routed and escalated within your organization. This endpoint does not modify any data and is safe for frequent calls, but be mindful of rate limits. Note that it only provides information for a single policy; to list multiple policies, you would need a different endpoint.Input Parameters
Output
Get event integrations by id
Get event integrations by id
PAGERDUTY_GET_EVENT_INTEGRATIONS_BY_IDRetrieves a list of integrations associated with a specific event orchestration in PagerDuty. This endpoint allows users to fetch all the integrations that are configured for a particular event orchestration, providing insights into how incidents are being routed and managed. It’s useful for auditing the current setup of an event orchestration or when planning to modify the orchestration’s integration configuration. The endpoint returns details about each integration, which may include integration types, configurations, and other relevant metadata. Use this when you need to review or analyze the integrations tied to a specific event orchestration for troubleshooting, reporting, or system optimization purposes.Input Parameters
Output
Get event orchestration by id
Get event orchestration by id
List cache variables for event orchestration
List cache variables for event orchestration
PAGERDUTY_GET_EVENT_ORCHESTRATION_CACHE_VARIABLESLists all cache variables configured for a specific Global Event Orchestration. Cache variables store dynamic data extracted from events, enabling complex routing rules and automation workflows based on event history and context. Returns up to 100 cache variables per orchestration with their configuration, conditions, enabled/disabled state, and metadata. Cache variable types: - recent_value: Stores CEF or raw event data - trigger_event_count: Counts events matching conditions - external_data: Stores data from external sources Use this to audit configurations, debug routing logic, or export orchestration settings for documentation. Requires Event Intelligence/Digital Operations plan or PagerDuty AIOps add-on, Advanced Event Orchestration pricing tier, API token with event_orchestrations:read scope, and Team Manager permissions or above.Input Parameters
Output
Get event orchestration global
Get event orchestration global
PAGERDUTY_GET_EVENT_ORCHESTRATION_GLOBALGet the Global Orchestration configuration for an Event Orchestration. Returns the global-level routing rules and configurations that process all events sent to this orchestration before they reach service-specific rules. The response includes rule sets (starting with ‘start’ set), catch-all actions, parent orchestration reference, and metadata. Use this to view or audit the global event routing logic for an orchestration. Scoped OAuth requires: event_orchestrations.readInput Parameters
Output
Get event orchestration integration
Get event orchestration integration
Get extension schema by id
Get extension schema by id
Get impact by status page id
Get impact by status page id
PAGERDUTY_GET_IMPACT_BY_STATUS_PAGE_IDRetrieves detailed information about a specific impact level configuration on a PagerDuty status page. Impacts are predefined severity descriptors (such as ‘Minor’, ‘Major’, or ‘Critical’) that describe how business services are affected during incidents. This endpoint returns the configuration details for a specific impact level, including its ID, name, and description. Use this action when you need to understand the details of a particular impact level, such as when creating status page posts or analyzing how incidents are categorized. To get a list of all available impacts for a status page, use the ‘Get Status Page Impacts By ID’ action first. Note: This retrieves impact level metadata, not information about actual incidents affecting services.Input Parameters
Output
Get incident alert details
Get incident alert details
PAGERDUTY_GET_INCIDENT_ALERT_DETAILSRetrieves detailed information about a specific alert associated with a particular incident in PagerDuty. This endpoint is used when you need to access the properties and current state of an individual alert within the context of its parent incident. It’s particularly useful for tracking the progression of an alert, understanding its current status, and gathering related metadata. The endpoint should be called when detailed information about a single alert is required, rather than for bulk operations or listing multiple alerts. Note that this endpoint focuses on retrieving data and does not modify the alert or incident.Input Parameters
Output
Get incident log entries by id
Get incident log entries by id
PAGERDUTY_GET_INCIDENT_LOG_ENTRIES_BY_IDRetrieves a page of log entries for a specific PagerDuty incident, with optional date-range and overview filters. Entries provide history of actions, notifications, and status changes; pagination can be used to retrieve further entries.Input Parameters
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.true, will return a subset of log entries that show only the most important changes to the incident.Output
Get incident workflow action by id
Get incident workflow action by id
PAGERDUTY_GET_INCIDENT_WORKFLOW_ACTION_BY_IDRetrieves a PagerDuty incident workflow action by ID for inspection before using it in a workflow. The action details can include its metadata, inputs, and outputs; this operation does not execute or modify the action.Input Parameters
Output
Get incident workflows
Get incident workflows
PAGERDUTY_GET_INCIDENT_WORKFLOWSLists all incident workflows configured in your PagerDuty account. Incident workflows are automated sequences of actions that execute during incident response to streamline processes like notifications, status updates, and integrations. This read-only endpoint retrieves workflow metadata including names, descriptions, associated teams, and optionally the workflow steps themselves. Use cases: - Browse available workflows to understand incident response automation - Find a specific workflow by name using the query filter - Audit which teams own which workflows - Retrieve workflow IDs for use with other workflow management actions Supports pagination and filtering. Use the ‘include’ parameter to fetch additional details like workflow steps or team information in a single request.Input Parameters
Output
Get incident workflows actions
Get incident workflows actions
PAGERDUTY_GET_INCIDENT_WORKFLOWS_ACTIONSLists available PagerDuty incident workflow actions to help design or update workflows. Filter by keyword and use cursor pagination to browse action details, which may include descriptions and configurable inputs.Input Parameters
limit parameter used in the request or the maximum request size of the API.next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.Output
Get Jira Cloud account mappings
Get Jira Cloud account mappings
PAGERDUTY_GET_JIRA_CLOUD_ACCOUNT_MAPPINGSLists all account mappings between PagerDuty and Jira Cloud instances. Use this to retrieve the integration mappings that link PagerDuty accounts (by subdomain) to Jira Cloud instances (by base URL). This is useful for verifying configured integrations, auditing cross-platform connections, or managing Jira-PagerDuty sync configurations.Input Parameters
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 PagerDuty’s Pagination Docs for more information.Output
Get log entries
Get log entries
PAGERDUTY_GET_LOG_ENTRIESRetrieves paginated PagerDuty incident log entries, with filters for date range and teams and an optional overview of important changes. Use it to review incident activity and responses.Input Parameters
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.teams ability to use this parameter.true, will return a subset of log entries that show only the most important changes to the incident.Output
Get maintenance window by id
Get maintenance window by id
PAGERDUTY_GET_MAINTENANCE_WINDOW_BY_IDRetrieves detailed information about a specific maintenance window in PagerDuty. This endpoint allows users to access the configuration, schedule, and status of a particular maintenance window using its unique identifier. It’s useful for reviewing planned maintenance periods, verifying window settings, or checking the current status of a maintenance window. The endpoint should be used when detailed information about a single maintenance window is needed, rather than for listing all maintenance windows or creating new ones.Input Parameters
Output
Get oauth delegations revocation requests status
Get oauth delegations revocation requests status
PAGERDUTY_GET_OAUTH_DELEGATIONS_REVOCATION_REQUESTS_STATUSDEPRECATED: This endpoint is deprecated. The DELETE /oauth_delegations endpoint is now synchronous and completes immediately, eliminating the need to check revocation request status separately. Get the status of all OAuth delegations revocation requests for this account, specifically how many requests are still pending processing. OAuth delegations represent instances of app authorization (e.g., mobile app, Slack, Microsoft Teams) to access a PagerDuty account. This endpoint was previously used when deletion was asynchronous. Access Requirements: - Limited to account owners and admins only - Scoped OAuth requires: oauth_delegations.read Note: Since the DELETE operation is now synchronous, you should use the PAGERDUTY_DELETE_ALL_OAUTH_DELEGATIONS action directly, which returns the result immediately without needing to poll for status. DEPRECATED: returns 404. Use PAGERDUTY_DELETE_ALL_OAUTH_DELEGATIONS, which returns the result directly.Input Parameters
Output
Get paused incident alerts
Get paused incident alerts
PAGERDUTY_GET_PAUSED_INCIDENT_ALERTSRetrieves the most recent paused incident alerts from PagerDuty for a specified reporting period. This endpoint returns up to 5 of the most recent alerts that were triggered after being paused, and up to 5 of the most recent alerts that were resolved after being paused. Alerts can be paused by two mechanisms: - Auto-Pause Incident Notifications: PagerDuty’s ML-based feature that automatically pauses notifications for transient alerts that typically auto-resolve - Event Orchestration Rules: User-configured rules that pause incident creation for predefined periods Use this endpoint to: - Monitor the effectiveness of Auto-Pause Incident Notifications - Review alerts that were paused and subsequently triggered or resolved - Audit pause behavior across services - Analyze patterns in paused alerts to optimize notification rules Note: This feature requires Digital Operations (legacy) or Enterprise Incident Management plans, or the AIOps add-on. Access without the required plan will result in a 403 Forbidden error.Input Parameters
Output
Get post from status page by id
Get post from status page by id
PAGERDUTY_GET_POST_FROM_STATUS_PAGE_BY_IDRetrieves detailed information about a specific post on a PagerDuty status page. This endpoint allows you to fetch the content, timestamp, and any associated metadata for a particular update or message that has been posted to a status page. It’s particularly useful for retrieving historical updates about incidents, maintenance notices, or general service status communications. Use this endpoint when you need to access or display the full details of a specific status update, such as when building a custom status page interface or integrating PagerDuty status updates into another system. Note that this endpoint only retrieves information for existing posts; it cannot be used to create, modify, or delete posts.Input Parameters
Output
Get response plays
Get response plays
PAGERDUTY_GET_RESPONSE_PLAYSLists legacy PagerDuty Response Plays, optionally filtering by name or manual-run eligibility. Response Plays packaged incident actions for a consistent response. DEPRECATED: PagerDuty removed the Response Plays list endpoint; use Incident Workflows instead.Input Parameters
Output
Get rule from ruleset by id
Get rule from ruleset by id
PAGERDUTY_GET_RULE_FROM_RULESET_BY_IDRetrieves detailed information about a specific rule within a PagerDuty ruleset. This endpoint allows users to fetch the configuration and settings of an individual rule, which is essential for understanding how incidents are being automated and managed. It should be used when detailed information about a particular rule’s conditions, actions, or other properties is needed. This endpoint is particularly useful for auditing ruleset configurations, troubleshooting automation issues, or preparing to update rule settings. It does not modify any data and is safe for frequent use in monitoring or dashboard applications. However, it will not provide an overview of all rules in a ruleset or allow for rule modifications.Input Parameters
Output
Get schedules
Get schedules
PAGERDUTY_GET_SCHEDULESRetrieves a list of all schedules from your PagerDuty account. This endpoint provides essential information about on-call rotations, helping teams manage and organize their incident response workflows. Use this when you need to view all existing schedules, such as during schedule audits, team restructuring, or when setting up integrations that require schedule IDs. The endpoint returns basic details for each schedule, which can be used to make further API calls for more specific information. Note that this endpoint does not provide the full details of each schedule’s rotation patterns; for that, you would need to make additional API calls using the schedule IDs returned by this endpoint.Input Parameters
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.Output
Get SCIM resource types
Get SCIM resource types
PAGERDUTY_GET_SCIM_RESOURCE_TYPESGet SCIM resource types supported by PagerDuty’s SCIM service provider. Returns metadata about available resource types (User, Group) including their endpoints, schemas, and names. Use this to discover which SCIM resources are supported by PagerDuty before performing SCIM provisioning operations. This follows the SCIM 2.0 protocol specification for ResourceTypes discovery.Output
Get SCIM schema by ID
Get SCIM schema by ID
PAGERDUTY_GET_SCIM_SCHEMA_BY_IDRetrieves an individual SCIM schema definition by its unique identifier (ID). Returns the complete schema structure including all attribute definitions, data types, constraints, and metadata. Use this to understand the structure of SCIM resources like Users and Groups before creating or updating them, or to validate SCIM implementation compliance. Common schema IDs include User (urn:ietf:params:scim:schemas:core:2.0:User) and Group (urn:ietf:params:scim:schemas:core:2.0:Group).Input Parameters
Output
Get SCIM service provider config
Get SCIM service provider config
PAGERDUTY_GET_SCIM_SERVICE_PROVIDER_CONFIGRetrieves the SCIM 2.0 Service Provider Configuration for PagerDuty. This endpoint returns the capabilities and features supported by PagerDuty’s SCIM implementation, including support for PATCH, bulk operations, filtering, sorting, and authentication schemes. Use this to understand what SCIM operations are available before performing user provisioning or management tasks.Output
Get SCIM user
Get SCIM user
PAGERDUTY_GET_SCIM_USERRetrieves detailed information about a specific user from PagerDuty’s SCIM directory. Use this action when you need to fetch user profile information including display name, email, role, active status, job title, timezone, and license entitlements. This endpoint follows the SCIM 2.0 protocol standard for user provisioning and identity management.Input Parameters
Output
Get service custom field values
Get service custom field values
PAGERDUTY_GET_SERVICE_CUSTOM_FIELD_VALUESRetrieves the custom field values for a specific PagerDuty service. Use this when you need to fetch custom metadata or additional structured information associated with a service. Custom fields allow organizations to extend PagerDuty services with domain-specific data like cost centers, SLA tiers, or application versions.Input Parameters
Output
Get enablements for a service
Get enablements for a service
PAGERDUTY_GET_SERVICE_ENABLEMENTSRetrieves feature enablement settings for a specific PagerDuty service. Use this to check which features are enabled or disabled for a service, such as alert grouping or auto-pause notifications. This is useful when auditing service configurations or determining which capabilities are active on a service.Input Parameters
Output
Get service impacts by url slug
Get service impacts by url slug
PAGERDUTY_GET_SERVICE_IMPACTS_BY_URL_SLUGRetrieves service impacts for a specific status dashboard in PagerDuty. This endpoint allows users to fetch real-time information about how incidents or maintenance activities are affecting services displayed on a particular dashboard. It’s useful for monitoring the current state of services, understanding ongoing issues, and assessing the overall health of systems represented in the specified dashboard. The endpoint should be used when you need to programmatically access up-to-date service impact data for a known status dashboard, enabling integration with other monitoring or reporting tools. Note that this endpoint only provides information for a single dashboard at a time and requires knowledge of the dashboard’s URL slug.Input Parameters
Output
Get severity for status page
Get severity for status page
PAGERDUTY_GET_SEVERITY_FOR_STATUS_PAGERetrieves detailed information about a specific severity level on a particular status page in PagerDuty. This endpoint is used to fetch the configuration and metadata associated with a severity, which is crucial for understanding how incidents are categorized and communicated on a status page. It provides insights into how different levels of service disruptions are represented and managed within the PagerDuty system. This tool is essential for developers and administrators who need to programmatically access or audit severity configurations on status pages, enabling them to ensure consistent incident communication across their organization.Input Parameters
Output
Get specific post update status
Get specific post update status
PAGERDUTY_GET_SPECIFIC_POST_UPDATE_STATUSLists updates for a specific PagerDuty status page post, optionally filtering by review status. Use it to review how communications about an incident or maintenance event changed over time.Input Parameters
Output
Get status dashboard by id
Get status dashboard by id
Get status for status page by id
Get status for status page by id
PAGERDUTY_GET_STATUS_FOR_STATUS_PAGE_BY_IDRetrieves a specific status configuration for a PagerDuty status page by status page ID and status ID.Input Parameters
Output
Get status page impacts by id
Get status page impacts by id
PAGERDUTY_GET_STATUS_PAGE_IMPACTS_BY_IDLists impact level configurations for a PagerDuty status page, optionally filtered by incident or maintenance post type. Results may be paginated.Input Parameters
Output
Get status page subscription
Get status page subscription
PAGERDUTY_GET_STATUS_PAGE_SUBSCRIPTIONRetrieves detailed information about a specific subscription associated with a particular status page in PagerDuty. This endpoint allows users to fetch subscription details such as the subscriber’s contact information, notification preferences, and current subscription status. It should be used when you need to review or verify the details of an existing subscription for a status page. The endpoint is particularly useful for managing and auditing subscriber information, troubleshooting notification issues, or when updating subscription settings. Note that this endpoint only provides read access to subscription data and cannot be used to modify or create new subscriptions.Input Parameters
Output
Get team members by id
Get team members by id
PAGERDUTY_GET_TEAM_MEMBERS_BY_IDRetrieves a list of all members associated with a specific team in PagerDuty. This endpoint is useful for obtaining detailed information about the composition of a team, including user IDs, names, roles, and contact information of team members. It should be used when you need to review or audit team membership, update on-call rotations, or gather information for reporting purposes. The endpoint does not modify team membership; it only provides read access to the current team roster. Keep in mind that the response may be paginated for teams with a large number of members.Input Parameters
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.Output
Get team notification subscriptions
Get team notification subscriptions
PAGERDUTY_GET_TEAM_NOTIFICATION_SUBSCRIPTIONSRetrieves the notification subscriptions for a specific team in PagerDuty. This endpoint allows you to fetch detailed information about how a team is configured to receive notifications for various events and incidents. It’s particularly useful for auditing a team’s notification settings, understanding their alert preferences, and ensuring that the right people are notified at the right time. The endpoint should be used when you need to review or analyze a team’s current notification setup, but it won’t allow you to modify these settings directly. Keep in mind that the response may include sensitive information about team members and their notification preferences, so use this endpoint judiciously and in compliance with your organization’s data privacy policies.Input Parameters
Output
Get teams associated with action id
Get teams associated with action id
PAGERDUTY_GET_TEAMS_ASSOCIATED_WITH_ACTION_IDRetrieves the list of teams associated with a specific automation action in PagerDuty. This endpoint is useful for understanding which teams are responsible for or have access to a particular automated process in the incident management workflow. It can be used to audit team assignments, manage access control, or gather information for reporting purposes. The endpoint returns only the teams linked to the specified automation action and does not provide details about the action itself or other related resources.Input Parameters
Output
Get template by id
Get template by id
PAGERDUTY_GET_TEMPLATE_BY_IDRetrieves detailed information about a specific template in PagerDuty by its unique identifier. This endpoint is used to access the configuration and settings of a pre-defined template, which can include incident response procedures, notification rules, and other standardized actions. It’s particularly useful when you need to review or reference an existing template for incident management purposes. The endpoint returns comprehensive data about the template, but does not modify or create new templates.Input Parameters
Output
Get the service orchestration for a service
Get the service orchestration for a service
PAGERDUTY_GET_THE_SERVICE_ORCHESTRATION_FOR_A_SERVICEGet a Service Orchestration. A Service Orchestration allows you to create a set of Event Rules. The Service Orchestration evaluates Events sent to this Service against each of its rules, beginning with the rules in the “start” set. When a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this Service Orchestration for further processing. For more information see the API Concepts Document Scoped OAuth requires: services.readInput Parameters
Output
Get user notification subscriptions
Get user notification subscriptions
PAGERDUTY_GET_USER_NOTIFICATION_SUBSCRIPTIONSLists notification subscriptions for a specific PagerDuty user. Returns subscriptions to various entities like business services and incidents that the user has subscribed to for receiving notifications. Use this to audit which resources a user is monitoring, troubleshoot notification issues, or manage a user’s subscription preferences. The response includes subscription type (business_service, incident), subscribable IDs, and pagination details (limit, offset, more, total).Input Parameters
Output
Get user session by type
Get user session by type
PAGERDUTY_GET_USER_SESSION_BY_TYPERetrieves a specific PagerDuty user session by user ID, session type and session ID. The user sessions retrieval endpoint is deprecated.Input Parameters
Output
Get user sessions by id
Get user sessions by id
Get user status update notification rules
Get user status update notification rules
PAGERDUTY_GET_USER_STATUS_UPDATE_NOTIFICATION_RULESRetrieves status update notification rules for a specific PagerDuty user, including their contact methods. Contact method details can be included in the response; a total count may also be returned.Input Parameters
Output
Get webhook subscription by id
Get webhook subscription by id
PAGERDUTY_GET_WEBHOOK_SUBSCRIPTION_BY_IDRetrieves detailed information about a specific webhook subscription in PagerDuty. This endpoint allows you to fetch the configuration and status of a webhook subscription, including its delivery method, subscribed events, and any applied filters. Use this when you need to review or verify the settings of an existing webhook subscription, such as checking which events it’s configured to receive or confirming its current status. The endpoint provides a snapshot of the subscription’s configuration but does not include historical data about past webhook deliveries or failures.Input Parameters
Output
Get workflow integration
Get workflow integration
Get workflow integration connection
Get workflow integration connection
PAGERDUTY_GET_WORKFLOW_INTEGRATION_CONNECTIONGet details about a Workflow Integration Connection. Scoped OAuth requires: workflow_integrations:connections.readInput Parameters
Output
Install add on endpoint
Install add on endpoint
PAGERDUTY_INSTALL_ADD_ON_ENDPOINTThis endpoint allows you to install a new add-on to your PagerDuty account, enhancing its functionality with custom integrations. Add-ons can be either full-page or incident-specific, providing additional context or tools within the PagerDuty interface. Use this endpoint when you want to integrate external resources or custom dashboards into your PagerDuty workflow. The add-on must have a secure HTTPS source URL and a unique name within your account. Note that while you can install multiple add-ons, each must serve a distinct purpose and have a different name and source URL.Input Parameters
Output
Invoke automation action by ID
Invoke automation action by ID
PAGERDUTY_INVOKE_AUTOMATION_ACTION_BY_IDInvokes a specific automation action in PagerDuty, associating it with a particular incident. This endpoint allows you to trigger pre-defined automated tasks or workflows within the PagerDuty incident management system. It’s particularly useful for executing custom actions or scripts in response to specific incidents, enhancing the incident response process. The action is identified by its unique ID, and the invocation must be linked to an existing incident through its incident ID. This endpoint should be used when you need to programmatically execute automation actions as part of your incident management workflow or integration with other systems.Input Parameters
Output
List all workflow integration connections
List all workflow integration connections
PAGERDUTY_LIST_ALL_WORKFLOW_INTEGRATION_CONNECTIONSList all Workflow Integration Connections. Scoped OAuth requires: workflow_integrations:connections.readInput Parameters
next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.Output
List automation action details
List automation action details
PAGERDUTY_LIST_AUTOMATION_ACTION_DETAILSLists automation actions configured in a PagerDuty account for review or inventory. Results can be filtered by name, runner, classification, team, service, or action type and browsed using cursor pagination; name matching is case-insensitive and accepts substrings.Input Parameters
limit parameter used in the request or the maximum request size of the API.next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.any filters results to include the ones linked to runners only, thus omitting the results not linked to runners.Output
List extension schemas
List extension schemas
PAGERDUTY_LIST_EXTENSION_SCHEMASLists PagerDuty extension schemas, which describe types of outbound extensions such as webhooks and integrations. Results are paginated.Input Parameters
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.Output
List field options on a custom field
List field options on a custom field
PAGERDUTY_LIST_FIELD_OPTIONS_ON_A_CUSTOM_FIELDLists field options for a custom field on a PagerDuty incident type, identified by incident type ID or name and custom field ID.Input Parameters
Output
List incident status update subscribers
List incident status update subscribers
PAGERDUTY_LIST_INCIDENT_STATUS_UPDATE_SUBSCRIBERSRetrieves a list of subscribers to status updates for a specific incident in PagerDuty. This endpoint allows you to see all users or services that are currently subscribed to receive notifications about status changes for the given incident. It’s useful for understanding who is being kept informed about the incident’s progress. This tool should be used when you need to review or audit the notification list for an incident, ensuring that all necessary stakeholders are included. It does not modify the subscriber list; for adding or removing subscribers, separate endpoints would be required.Input Parameters
Output
List incident type custom fields
List incident type custom fields
List incident types
List incident types
List licenses
List licenses
PAGERDUTY_LIST_LICENSESLists all licenses for the PagerDuty account, showing current usage and available allocations. This endpoint retrieves license information including: - License name and type (e.g., “Enterprise Incident Management (Full User)”) - Current allocated users (current_value) - Available license allocations (allocations_available) - Valid user roles for each license type - Role group classification (FullUser, Stakeholder, etc.) Use this to: - Check available license allocations before creating users - Audit license usage and availability - Understand which roles are valid for each license type - Monitor license consumption across the account No parameters required - returns all licenses for the authenticated account.Output
List SCIM schemas
List SCIM schemas
PAGERDUTY_LIST_SCIM_SCHEMASRetrieves all SCIM schemas supported by the PagerDuty service provider. Returns a list of schema definitions including User, Group, and Enterprise User Extension schemas with their complete attribute structures, data types, and constraints. Use this to discover available SCIM schemas before creating or updating resources.Output
List SCIM users
List SCIM users
PAGERDUTY_LIST_SCIM_USERSLists users via the SCIM (System for Cross-domain Identity Management) API endpoint. Use when you need to retrieve user information in SCIM format, typically for identity provider integrations or user provisioning workflows. Supports pagination via startIndex and count parameters, and filtering by userName or externalId.Input Parameters
Output
List service custom fields
List service custom fields
PAGERDUTY_LIST_SERVICE_CUSTOM_FIELDSLists all custom fields available for services in PagerDuty. This endpoint returns a list of custom fields that can be used to add structured metadata to services. Custom fields allow teams to categorize and organize services with additional attributes beyond the standard service properties. Use this action when you need to discover available custom fields before setting or updating custom field values on services.Input Parameters
Output
List supporting service impacts
List supporting service impacts
PAGERDUTY_LIST_SUPPORTING_SERVICE_IMPACTSRetrieves information about the impacts of supporting services on a specific business service in PagerDuty. This endpoint is used to understand the relationships and dependencies between a primary business service and its supporting services, along with the potential impacts these relationships may have on incident management and service reliability. It’s particularly useful for assessing the cascading effects of incidents across interconnected services and for proactive risk management. The endpoint should be used when analyzing service dependencies, planning incident response strategies, or evaluating the overall resilience of your service infrastructure. Note that this endpoint focuses on impact information and may not provide real-time incident data or detailed metrics about the services themselves.Input Parameters
Output
List templates
List templates
PAGERDUTY_LIST_TEMPLATESLists PagerDuty templates with optional search, sorting and pagination. The request defaults to filtering for status update templates.Input Parameters
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.Output
List workflow integration connections
List workflow integration connections
PAGERDUTY_LIST_WORKFLOW_INTEGRATION_CONNECTIONSLists workflow integration connections for a specific integration, with optional name filtering and cursor pagination. Scoped OAuth requires workflow_integrations:connections.read.Input Parameters
Output
List workflow integrations
List workflow integrations
PAGERDUTY_LIST_WORKFLOW_INTEGRATIONSList available Workflow Integrations. Scoped OAuth requires: workflow_integrations.readInput Parameters
limit parameter used in the request or the maximum request size of the API.next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.Output
Manage cache variables for event service
Manage cache variables for event service
PAGERDUTY_MANAGE_CACHE_VARIABLES_FOR_EVENT_SERVICECreates a cache variable for a service event orchestration. Cache variables store temporary event data for use in orchestration rules. Requires Advanced Event Orchestration tier and Manager role. Configuration types: - recent_value: Stores latest value from event field (requires source, regex) - trigger_event_count: Counts matching events in time window (requires ttl_seconds) - external_data: Stores API-provided data (requires data_type, ttl_seconds) Use conditions to control updates. Reference in rules as cache_var.variable_name.Input Parameters
_reference if the object is a reference._reference if the object is a reference.Output
Merge source incidents into target incident
Merge source incidents into target incident
PAGERDUTY_MERGE_SOURCE_INCIDENTS_INTO_TARGET_INCIDENTMerges multiple source incidents into a target incident in PagerDuty’s incident management system. This endpoint allows users to consolidate related or duplicate incidents into a single, primary incident for streamlined management and resolution. The operation combines the specified source incidents into the target incident identified by the URL path, marking the source incidents as resolved. This tool should be used when multiple incidents are determined to be part of the same underlying issue or when consolidating incident management efforts. It’s particularly useful for reducing noise and focusing on the root cause of related issues. Note that this action is irreversible, so care should be taken to ensure that the incidents are truly related before merging.Input Parameters
Output
Migrate integration between orchestrations
Migrate integration between orchestrations
PAGERDUTY_MIGRATE_INTEGRATION_BETWEEN_ORCHESTRATIONSThis endpoint facilitates the migration of an integration from one event orchestration to another within PagerDuty. It allows users to reassign an existing integration to a different event orchestration, maintaining the integration’s configuration while updating its association. This operation is useful when restructuring event management workflows or optimizing incident routing. The endpoint should be used when there’s a need to change how a specific integration interacts with PagerDuty’s event processing system. It’s important to note that this process only changes the association and does not modify the integration’s settings or connected external services.Input Parameters
Output
Ping webhook subscription
Ping webhook subscription
PAGERDUTY_PING_WEBHOOK_SUBSCRIPTIONThe PingWebhookSubscription endpoint sends a test POST request to a specified webhook subscription in your PagerDuty account. This tool is used to verify that a webhook subscription is correctly configured and can receive notifications. It’s particularly useful after setting up a new webhook subscription or when troubleshooting integration issues. The endpoint doesn’t modify any data but simulates a real webhook delivery, allowing you to confirm that your systems can properly receive and process PagerDuty webhooks. Note that this tool only tests the delivery mechanism and doesn’t validate the processing of specific event types on your end.Input Parameters
Output
Post account subscription for business service
Post account subscription for business service
Post alert grouping settings
Post alert grouping settings
PAGERDUTY_POST_ALERT_GROUPING_SETTINGSCreates a new Alert Grouping Setting in PagerDuty, defining how alerts will be automatically grouped into incidents based on specified configurations. This endpoint allows users to set up intelligent alert grouping rules, improving incident management efficiency by reducing noise and consolidating related alerts. It’s particularly useful for teams looking to streamline their incident response process and minimize alert fatigue. The setting can be applied to one or multiple services, with the option to use content-based or intelligent grouping algorithms.Input Parameters
Output
Post analytic metrics on escalation policies
Post analytic metrics on escalation policies
PAGERDUTY_POST_ANALYTIC_METRICS_ON_ESCALATION_POLICIESRetrieves and aggregates analytics metrics for incidents related to escalation policies in PagerDuty. This endpoint allows for detailed filtering and customization of incident data, enabling users to analyze trends, performance, and patterns in their incident management process. It’s particularly useful for generating reports, identifying areas for improvement, and understanding the effectiveness of escalation policies over time. The endpoint supports various filtering options, time zone specifications, and time-based aggregation, making it a powerful tool for operational insights and decision-making in incident management.Input Parameters
Output
Post analytics metrics responder filters
Post analytics metrics responder filters
PAGERDUTY_POST_ANALYTICS_METRICS_RESPONDER_FILTERSThe AnalyzeResponderMetrics endpoint aggregates and analyzes responder performance metrics for PagerDuty incidents. It provides insights into response times, efficiency, and workload distribution. This tool is ideal for assessing and optimizing incident response processes, offering flexible filtering options for focused analysis. Note that it provides aggregated data, not real-time information, with a maximum analysis range of one year.Input Parameters
Output
Send change event to PagerDuty
Send change event to PagerDuty
PAGERDUTY_POST_CHANGE_EVENTSSend a change event to PagerDuty to track deployments, configuration changes, or other significant system modifications. Change events do not create incidents or notifications but provide valuable context for incident correlation and analysis. Use this action to: - Log deployments and code releases - Track configuration changes - Record infrastructure updates - Document system modifications - Provide context for incident investigation Change events can be viewed in PagerDuty’s change timeline and are automatically correlated with incidents to help teams understand what changed before an incident occurred. Note: This endpoint uses the Events API (events.pagerduty.com), not the REST API. You need an Events API v2 integration key (routing_key) from a service integration.Input Parameters
Output
Post event orchestration cache variables
Post event orchestration cache variables
PAGERDUTY_POST_EVENT_ORCHESTRATION_CACHE_VARIABLESCreates a new cache variable within a PagerDuty event orchestration. This endpoint allows you to define a cache variable that can store dynamic data related to events, either based on recent values extracted from event fields or by counting trigger events within a specified time range. Cache variables are useful for maintaining state across multiple events and can be used in event routing and automation rules. The created cache variable can be configured with conditions to determine when it should be updated and can be optionally disabled. This tool should be used when setting up complex event orchestrations that require stateful processing or when implementing advanced automation workflows in PagerDuty.Input Parameters
Output
Post incident metrics
Post incident metrics
PAGERDUTY_POST_INCIDENT_METRICSRetrieve analytics metrics for responders and teams including incident counts, response times, on-call hours, interruptions, escalations, and engagement statistics. Returns metrics like total incidents, mean time to acknowledge/resolve, on-call duration by level, interruptions by time period (business/off/sleep hours), and escalation/reassignment counts. All parameters are optional (defaults to yesterday’s data). Maximum date range: 1 year. Analytics data updates daily (not real-time). Use for performance reports, workload analysis, trend identification, and team comparisons. Date filters use ISO8601 format (e.g., “2026-01-01T00:00:00Z”).Input Parameters
Output
Post incident metrics with filters
Post incident metrics with filters
PAGERDUTY_POST_INCIDENT_METRICS_WITH_FILTERSThis endpoint retrieves and aggregates analytics metrics for incidents across all teams in PagerDuty. It allows users to apply various filters and parameters to analyze incident data, such as creation date range, urgency, team associations, and more. The endpoint is particularly useful for generating reports, identifying trends, and performing operational reviews across multiple teams and services. It provides flexibility in data aggregation and sorting, enabling users to customize their analysis based on specific needs and time frames. However, users should be aware of the one-year limitation on the date range when using the created_at filters.Input Parameters
Output
Post incident note using id
Post incident note using id
PAGERDUTY_POST_INCIDENT_NOTE_USING_IDAdds a new note to an existing incident in PagerDuty. This endpoint allows users to append additional information, updates, or comments to a specific incident identified by its unique ID. It’s particularly useful for documenting the progress of incident resolution, sharing important observations, or recording actions taken. The note content can include any text relevant to the incident management process, helping teams collaborate and maintain a clear record of the incident’s timeline and handling.Input Parameters
Output
Post incidents analytics with filters
Post incidents analytics with filters
PAGERDUTY_POST_INCIDENTS_ANALYTICS_WITH_FILTERSThe AnalyzeRawIncidents endpoint retrieves and analyzes raw incident data from PagerDuty. It allows users to fetch detailed information about incidents with various filtering options. This endpoint is useful for generating custom reports, performing trend analysis, or investigating specific incident sets. It supports extensive filtering, pagination, and result customization, making it ideal for in-depth incident reviews and pattern analysis.Input Parameters
Output
Post incidents metrics filtered by service
Post incidents metrics filtered by service
PAGERDUTY_POST_INCIDENTS_METRICS_FILTERED_BY_SERVICEThe AnalyzeIncidentMetrics endpoint aggregates and analyzes incident data for PagerDuty services based on specified filters and parameters. It allows users to generate detailed reports and insights on incident management performance across various dimensions such as time, urgency, teams, and services. This endpoint is particularly useful for operational reviews, trend analysis, and performance monitoring of incident response processes. The tool provides flexible filtering options to focus on specific subsets of incidents and supports various time-based aggregations for comprehensive analysis. It’s important to note that while the endpoint offers extensive customization, it has a maximum supported time range of one year between the start and end dates for incident creation.Input Parameters
Output
Post incident status update
Post incident status update
PAGERDUTY_POST_INCIDENT_STATUS_UPDATEPosts a status update for a specific incident in PagerDuty. This endpoint allows you to add new information or progress reports to an ongoing incident, keeping stakeholders informed about the current state of the issue. It supports both simple text updates and more detailed custom HTML email updates. Use this when you need to communicate important changes, actions taken, or any relevant information about the incident to the team or stakeholders. The endpoint is particularly useful for maintaining a clear timeline of the incident’s progression and ensuring all parties have the most up-to-date information. Note that while a simple message is always required, you have the option to provide additional details through a custom HTML email by including both the ‘subject’ and ‘html_message’ fields.Input Parameters
Output
Post responder incidents with filters
Post responder incidents with filters
PAGERDUTY_POST_RESPONDER_INCIDENTS_WITH_FILTERSRetrieves raw incident analytics for a specific PagerDuty responder for workload analysis and operational reviews. Filter by creation time, urgency, major incident status, team, service, or priority, and use cursor pagination and ordering to navigate results. Team filtering requires the account’s teams ability.Input Parameters
desc.incident_created_at.Output
Post service automation action
Post service automation action
PAGERDUTY_POST_SERVICE_AUTOMATION_ACTIONThis endpoint adds a service to an existing automation action in PagerDuty. It allows users to associate a specific service with an automation action, enabling the action to be applied to incidents or events related to that service. The endpoint requires the automation action’s ID in the URL path and a service reference object in the request body. It should be used when configuring or updating automation actions to include additional services in their scope of operation. This endpoint is particularly useful for expanding the reach of automation actions across multiple services within an organization’s PagerDuty setup.Input Parameters
Output
Post team notification subscription
Post team notification subscription
PAGERDUTY_POST_TEAM_NOTIFICATION_SUBSCRIPTIONCreates notification subscriptions for a specific team in PagerDuty. This endpoint allows you to subscribe a team to receive notifications for one or more incidents or business services. Use this when you want to ensure a team is notified about specific critical events or the status of important business services. The endpoint requires a list of subscribable entities, each identified by a unique ID and type. It’s particularly useful for setting up or updating a team’s notification preferences in bulk. Note that this endpoint only creates new subscriptions and doesn’t affect existing ones.Input Parameters
Output
Post team to runner
Post team to runner
PAGERDUTY_POST_TEAM_TO_RUNNERThis endpoint adds a team to an Automation Action Runner in PagerDuty. It allows you to associate a specific team with a runner, enabling better organization and management of automation processes within your incident response workflow. Use this endpoint when you need to grant a team access to or responsibility for a particular Automation Action Runner. This association is crucial for maintaining proper access control and ensuring that the right teams are involved in specific automation tasks. The endpoint requires the runner’s ID and the team’s reference information, including its unique identifier and type.Input Parameters
Output
Preview schedule object
Preview schedule object
PAGERDUTY_PREVIEW_SCHEDULE_OBJECTThe preview_schedule endpoint allows you to simulate and visualize a PagerDuty schedule configuration before actually creating or updating it. This tool is essential for validating complex on-call rotations, ensuring proper coverage, and identifying potential gaps or conflicts in your schedule design. It accepts a complete schedule object, including multiple layers, users, and restrictions, and returns a preview of how the schedule would operate if implemented. This preview includes rendered schedule entries, showing exactly who would be on-call at specific times. Use this endpoint when designing new schedules, modifying existing ones, or troubleshooting scheduling issues to ensure optimal on-call coverage without affecting your live environment. The preview does not create or modify any actual schedules in your PagerDuty account.Input Parameters
overflow=true is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z: - If you don”t pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T10:00:00Z and end of 2011-06-01T14:00:00Z. - If you do pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.Output
Render template for incident
Render template for incident
PAGERDUTY_RENDER_TEMPLATE_FOR_INCIDENTRenders a specific template for a given incident in PagerDuty. This endpoint allows you to generate a formatted report or message based on a pre-defined template and the provided incident information. It’s particularly useful for creating standardized incident reports, status updates, or notifications. The rendered template can incorporate details from the incident, a status update message, and any additional external data provided. Use this endpoint when you need to generate consistent, formatted output for incident communication or documentation purposes. Note that the template itself must be created and configured separately; this endpoint only handles the rendering process based on the template identified by the URL parameter {id}.Input Parameters
Output
Retrieve abilities list
Retrieve abilities list
Test ability availability by ID
Test ability availability by ID
PAGERDUTY_RETRIEVE_ABILITY_BY_IDTests whether a specific ability (feature capability) is available to your PagerDuty account using its unique identifier. This endpoint checks if a particular feature, such as ‘urgencies’, ‘manage_schedules’, or ‘event_rules’, is available based on your account’s pricing plan and configuration. A successful response (HTTP 204) indicates the ability exists and is available; a 404 error indicates the ability is not available or doesn’t exist. This is useful for programmatically checking feature availability before attempting to use specific functionality. Use the list abilities endpoint to discover available ability IDs. The endpoint is read-only and does not modify any abilities.Input Parameters
Output
Retrieve action services by id
Retrieve action services by id
PAGERDUTY_RETRIEVE_ACTION_SERVICES_BY_IDRetrieves services associated with a specified automation action. The response may indicate that more results are available.Input Parameters
Output
Check if service event orchestration is active
Check if service event orchestration is active
PAGERDUTY_RETRIEVE_ACTIVE_SERVICE_EVENT_BY_IDCheck if event orchestration is active for a specific PagerDuty service. This endpoint returns a boolean flag indicating whether Service Event Orchestration is currently active for the specified service. When active, events sent to this service are processed through the service’s event orchestration rules before creating incidents. Use this to quickly determine if a service has event orchestration enabled or disabled. This is useful for validating service configuration or troubleshooting event processing behavior. Note: This endpoint only returns the active status (true/false), not the actual orchestration rules or configuration. To view or modify the orchestration rules, use the service orchestration endpoints instead.Input Parameters
Output
Retrieve addon by id
Retrieve addon by id
PAGERDUTY_RETRIEVE_ADDON_BY_IDRetrieves details of a specific PagerDuty add-on by ID, including its name, type, source URL, and associated services when available.Input Parameters
Output
Retrieve alert grouping settings by id
Retrieve alert grouping settings by id
PAGERDUTY_RETRIEVE_ALERT_GROUPING_SETTINGS_BY_IDRetrieves the alert grouping settings for a specific configuration identified by its unique ID in PagerDuty. This endpoint allows users to access detailed information about how alerts are grouped for a particular service or team. It’s useful for reviewing current grouping rules, understanding the logic behind incident correlation, and auditing alert management configurations. The endpoint should be used when you need to examine or verify the existing alert grouping settings, which can be crucial for optimizing incident response and reducing alert fatigue. It does not modify any settings and is intended for read-only operations.Input Parameters
Output
Retrieve automation action invocation by id
Retrieve automation action invocation by id
PAGERDUTY_RETRIEVE_AUTOMATION_ACTION_INVOCATION_BY_IDRetrieves detailed information about a specific automation action invocation in PagerDuty. This endpoint allows you to fetch the current state, results, and metadata of a previously executed automation action. It’s particularly useful for tracking the progress of long-running automations, auditing past actions, or troubleshooting failed invocations. The endpoint should be used when you need to review the outcome of a specific automation run or gather data for reporting purposes. Note that this endpoint only provides information about the invocation itself and does not allow modification of the automation action or re-running of the invocation.Input Parameters
Output
Retrieve automation action invocations
Retrieve automation action invocations
PAGERDUTY_RETRIEVE_AUTOMATION_ACTION_INVOCATIONSRetrieves a list of automation action invocations from the PagerDuty incident management platform. This endpoint allows users to query and review the history of automated actions that have been executed within their PagerDuty environment. It can be used to audit automation processes, track the frequency and timing of automated responses, and analyze the effectiveness of incident management workflows. The endpoint is particularly useful for administrators and DevOps teams who need to monitor and optimize their automated incident response strategies. Note that while this endpoint provides historical data, it does not trigger new automated actions or modify existing ones.Input Parameters
Output
Retrieve automation action runner teams
Retrieve automation action runner teams
PAGERDUTY_RETRIEVE_AUTOMATION_ACTION_RUNNER_TEAMSRetrieves detailed information about a specific team association with an Automation Actions runner in PagerDuty. This endpoint confirms whether a particular team has access to a given runner and returns the team’s details. Use this action when you need to: - Verify that a specific team is associated with a runner - Get team details (ID, name summary, URLs) for a known team-runner pair - Confirm access permissions before performing automation actions - Audit team-runner relationships for security or compliance purposes The endpoint returns a team object containing: id, type, summary, self (API URL), and html_url. This is a read-only operation that does not modify any associations. Note: To get all teams associated with a runner, use the ‘fetch_runner_teams_integration’ action instead. To create a new team-runner association, use ‘post_team_to_runner’.Input Parameters
Output
Retrieve automation service action
Retrieve automation service action
PAGERDUTY_RETRIEVE_AUTOMATION_SERVICE_ACTIONRetrieves detailed information about the association between a specific automation action and a service in PagerDuty. This endpoint returns both the automation action details (including ID, name, type, and configuration) and the service details (including ID, name, type, and status) for the specified association. Use this endpoint when you need to: - Verify that an automation action is correctly associated with a service - Retrieve configuration details for an existing action-service association - Audit which automation actions are linked to specific services - Understand the automation setup for incident management on a particular service Note: This endpoint requires both an automation action ID and a service ID. The association must already exist - use the associate endpoint to create new associations. Automation Actions is a premium feature and requires appropriate account permissions.Input Parameters
Output
Retrieve business service by id
Retrieve business service by id
PAGERDUTY_RETRIEVE_BUSINESS_SERVICE_BY_IDRetrieves detailed information about a specific business service by its ID. Returns the business service’s name, description, point of contact, associated team, and other metadata. Use this when you need to view or verify the details of a single business service. Note: This endpoint returns configuration data only - it does not include real-time incident data, performance metrics, or service dependencies.Input Parameters
Output
Retrieve business service dependencies
Retrieve business service dependencies
PAGERDUTY_RETRIEVE_BUSINESS_SERVICE_DEPENDENCIESRetrieves the service dependencies for a specific business service in PagerDuty. This endpoint allows you to fetch a list of services that are dependent on or related to the specified business service, helping to understand the interconnections within your incident management structure. Use this when you need to analyze the impact of incidents on critical business functions or when planning incident response strategies. The endpoint provides a snapshot of the current dependency structure and does not include historical data or future planned changes to service relationships.Input Parameters
Output
Retrieve business service impactors
Retrieve business service impactors
PAGERDUTY_RETRIEVE_BUSINESS_SERVICE_IMPACTORSRetrieves impactors (typically incidents) currently affecting business services. Use this to monitor which incidents are impacting services, identify cascading failures, and prioritize incident response based on business impact. Parameters: - ids (optional): Filter by specific business service IDs. Accepts a single ID (string) or multiple IDs (list). Omit to get impactors for all services. Returns: List of impactors with IDs and types, plus pagination info. Currently limited to active incidents only - no historical data.Input Parameters
Output
Retrieve business service impacts
Retrieve business service impacts
PAGERDUTY_RETRIEVE_BUSINESS_SERVICE_IMPACTSRetrieves a list of business services impacted by a specific PagerDuty incident. This helps assess the broader business impact and identify which business stakeholders need to be notified during incident response. Use this action to: - Understand which business services are affected by an incident - Prioritize incident response based on critical business service impacts - Identify stakeholders who need to be notified - Generate impact reports for incident post-mortems Returns a list of impacted business services with their details (ID, name, links), or an empty array if the incident doesn’t impact any business services. Business services must be configured in PagerDuty with qualifying incident priority levels to appear in results. Works with both triggered and resolved incidents.Input Parameters
Output
Retrieve business services
Retrieve business services
PAGERDUTY_RETRIEVE_BUSINESS_SERVICESRetrieve a list of business services from your PagerDuty account. Business services represent the high-level business capabilities that your technical services support. They provide a business-oriented view of your infrastructure, helping you understand which business functions are affected during incidents. This endpoint supports pagination through the limit and offset parameters, allowing you to efficiently retrieve large lists of business services. Use the total parameter to get the exact count of business services (note: this may impact response time). Common use cases: - Getting an overview of all business services in your organization - Building dashboards that show business service status - Auditing and reporting on business service configurations - Integrating business service data with external systemsInput Parameters
Output
Retrieve change event by id
Retrieve change event by id
PAGERDUTY_RETRIEVE_CHANGE_EVENT_BY_IDRetrieves detailed information about a specific change event by its unique ID. Change events represent deployments, configuration changes, infrastructure updates, or other system modifications that are tracked for incident correlation and analysis. Unlike incidents or alerts, change events are informational and do not trigger notifications. Use Cases: - View details of a specific deployment or change - Investigate changes that occurred before an incident - Audit change management processes - Track the timeline and impact of system modifications Requirements: - Requires the PagerDuty AIOps add-on - Requires change_events.read scope/permission Note: Change events are created via the Events API v2 /v2/change/enqueue endpoint or automatically from integrated tools like CI/CD pipelines. This endpoint retrieves the details of an already-created change event.Input Parameters
Output
Retrieve change event information
Retrieve change event information
PAGERDUTY_RETRIEVE_CHANGE_EVENT_INFORMATIONRetrieves change events from PagerDuty. Change events track deployments, configuration changes, and infrastructure updates in your external systems. They provide context for incident correlation by showing what changed before an incident occurred. Use this to review deployments, track infrastructure changes, correlate changes with incidents, or investigate what changed before problems started. Change events appear in PagerDuty’s timeline and are automatically correlated with incidents. Filter by team_ids, integration_ids, or time range (since/until). Use limit/offset for pagination. Note: Requires PagerDuty AIOps add-on. Events older than 90 days are not shown.Input Parameters
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.teams ability to use this parameter.Output
Retrieve current user info
Retrieve current user info
PAGERDUTY_RETRIEVE_CURRENT_USER_INFORetrieves the profile information of the currently authenticated user in the PagerDuty system. This endpoint provides access to personal details, settings, and account information associated with the user making the API request. It’s particularly useful for applications that need to display or utilize user-specific data without requiring additional input. The endpoint should be used when an application needs to fetch up-to-date information about the current user, such as their name, email, role, or other account-related details. Note that this endpoint does not provide information about other users in the organization, nor does it allow for modifications to the user profile.Input Parameters
Output
Retrieve event orchestration router by id
Retrieve event orchestration router by id
PAGERDUTY_RETRIEVE_EVENT_ORCHESTRATION_ROUTER_BY_IDRetrieves the router configuration for a specific event orchestration in PagerDuty. This endpoint allows you to fetch detailed information about how incidents and events are routed within a particular event orchestration setup. Use this endpoint when you need to understand or audit the current routing logic for an event orchestration, such as determining which teams or escalation policies are assigned to handle specific types of incidents. The returned data will include routing rules, conditions, and associated actions, but will not modify any existing configurations. This endpoint is particularly useful for incident response planning and optimization of event management workflows.Input Parameters
Output
Retrieve extension by id
Retrieve extension by id
PAGERDUTY_RETRIEVE_EXTENSION_BY_IDRetrieves detailed information about a specific extension in PagerDuty. This endpoint allows users to fetch the configuration and status of an individual extension by providing its unique identifier. It is particularly useful when you need to review or verify the settings of a specific extension, such as its type, configuration parameters, or associated service. This endpoint should be used when detailed information about a known extension is required, but it cannot be used to list all extensions or modify extension settings.Input Parameters
Output
Retrieve extension list
Retrieve extension list
PAGERDUTY_RETRIEVE_EXTENSION_LISTRetrieves a paginated list of extensions associated with the authenticated PagerDuty account. Extensions are integrations that enhance PagerDuty’s functionality, such as webhooks, custom notification methods, or third-party service connections. This endpoint supports filtering by extension name (query parameter), extension schema ID (vendor type), and extension object ID (the resource the extension is attached to, such as a service). Use this to audit active extensions, discover webhooks configured for specific services, or find all extensions of a particular type. The include parameter can request additional details like extension_objects or extension_schemas to be embedded in the response for richer context without additional API calls.Input Parameters
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.Output
Retrieve incident by incident id
Retrieve incident by incident id
PAGERDUTY_RETRIEVE_INCIDENT_BY_INCIDENT_IDRetrieves detailed information about a specific incident in PagerDuty using its unique identifier. This endpoint allows users to access comprehensive data about an individual incident, including its current status, assigned responders, and related metadata. It is particularly useful for tracking the progress of an ongoing incident, reviewing historical incident data, or integrating incident details into external systems or reports. The endpoint should be used when specific incident information is needed, rather than for retrieving bulk or summarized incident data. Note that this endpoint provides a snapshot of the incident at the time of the request and may not reflect real-time updates without subsequent API calls.Input Parameters
Output
Retrieve incident custom fields
Retrieve incident custom fields
PAGERDUTY_RETRIEVE_INCIDENT_CUSTOM_FIELDSLists PagerDuty incident custom field definitions, optionally requesting field options, for reviewing the structure of incident data. DEPRECATED: Incident Custom Fields endpoints have been superseded by custom fields in Incident Types.Input Parameters
Output
Retrieve incident custom field values
Retrieve incident custom field values
PAGERDUTY_RETRIEVE_INCIDENT_CUSTOM_FIELD_VALUESRetrieves the custom field values associated with a specific incident in PagerDuty. This endpoint allows users to access additional metadata that has been added to an incident, providing more context and enabling better incident management. It should be used when detailed information about an incident’s custom fields is needed, such as for reporting, analysis, or integration with other systems. The endpoint returns only the custom field values and does not modify the incident or its fields.Input Parameters
Output
Retrieve incident field options
Retrieve incident field options
PAGERDUTY_RETRIEVE_INCIDENT_FIELD_OPTIONSRetrieves predefined field options for a specific PagerDuty incident custom field, useful for inspecting selectable values and validating input.Input Parameters
Output
Retrieve incident workflow by id
Retrieve incident workflow by id
PAGERDUTY_RETRIEVE_INCIDENT_WORKFLOW_BY_IDRetrieves detailed information about a specific incident workflow in PagerDuty. This endpoint allows users to fetch the configuration, steps, and other relevant details of an incident workflow based on its unique identifier. It is particularly useful when you need to review or audit the structure of an existing workflow, or when you want to display the workflow details in a user interface. The endpoint returns comprehensive information about the workflow, which may include its name, description, steps, triggers, and associated incident types. It should be used when specific information about a known incident workflow is required, rather than for listing or searching workflows.Input Parameters
Output
Retrieve incident workflow triggers
Retrieve incident workflow triggers
PAGERDUTY_RETRIEVE_INCIDENT_WORKFLOW_TRIGGERSRetrieves a list of triggers associated with incident workflows in PagerDuty. This endpoint allows you to fetch information about the conditions or events that initiate automated incident response processes. Use this endpoint when you need to review, audit, or manage the triggers configured for your incident workflows. It provides valuable insights into what events can start an incident workflow, helping in the optimization of incident management strategies. The endpoint returns details about each trigger, which may include its configuration, associated workflow, and activation criteria. Note that this endpoint only provides information about existing triggers and does not allow for the creation or modification of triggers.Input Parameters
limit parameter used in the request or the maximum request size of the API.next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.incident_id is provided.service_id is provided.Output
Retrieve integration by service id
Retrieve integration by service id
PAGERDUTY_RETRIEVE_INTEGRATION_BY_SERVICE_IDRetrieves detailed information about a specific integration associated with a particular service in PagerDuty. This endpoint allows you to fetch the configuration and status of an integration, which can be crucial for understanding how external systems or tools are connected to your PagerDuty service. Use this when you need to review or troubleshoot a specific integration’s settings within the context of a service. It’s particularly useful for auditing your integrations or preparing for updates to your incident management workflow. Note that this endpoint only provides read access to integration details and cannot be used to modify the integration.Input Parameters
Output
Retrieve license allocations
Retrieve license allocations
PAGERDUTY_RETRIEVE_LICENSE_ALLOCATIONSRetrieves the current license allocations for the PagerDuty account, showing which users have been allocated which licenses. Use this endpoint to audit license usage, track license distribution, or manage license allocation across your organization. The response includes: - A list of license allocations with user references, license details (name, valid roles, role group), and allocation timestamps - Pagination information (limit, offset, total count, and whether more results exist) This is a read-only endpoint - it does not modify license allocations. Use the optional limit and offset parameters to paginate through results for accounts with many license allocations.Input Parameters
Output
Retrieve list of services
Retrieve list of services
PAGERDUTY_RETRIEVE_LIST_OF_SERVICESRetrieves a list of services configured in the PagerDuty account. This endpoint allows you to fetch details about various services set up for incident management and alerting. It’s particularly useful for getting an overview of all services, their configurations, and associated teams or escalation policies. The endpoint supports filtering, sorting, and pagination to manage large sets of services efficiently. Use this when you need to audit existing services, prepare for bulk updates, or integrate service information into other systems. Note that the response may not include full details of each service, and separate API calls might be necessary to fetch comprehensive information for individual services.Input Parameters
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.teams ability to use this parameter.Output
Retrieve log entry by id
Retrieve log entry by id
PAGERDUTY_RETRIEVE_LOG_ENTRY_BY_IDRetrieves detailed information about a specific log entry in the PagerDuty system. This endpoint is used to access the complete record of an event or action that occurred within PagerDuty, such as incident updates, user actions, or system changes. It’s particularly useful for auditing purposes, investigating specific actions taken during incident management, or gathering detailed information about system activities. The endpoint returns a single log entry based on the provided ID, allowing for precise tracking and analysis of individual events within the incident management lifecycle. Note that this endpoint is not designed for real-time monitoring or bulk log retrieval; it’s intended for accessing specific, historical log entries when detailed information about a particular event is required.Input Parameters
Output
Retrieve maintenance windows
Retrieve maintenance windows
PAGERDUTY_RETRIEVE_MAINTENANCE_WINDOWSRetrieves a list of maintenance windows from the PagerDuty incident management platform. Maintenance windows are scheduled periods during which alerts and notifications for specified services are suppressed to allow for system maintenance or updates without triggering unnecessary incidents. This endpoint should be used to get an overview of all maintenance windows, their schedules, and affected services. It supports filtering by team, service, and search query, as well as pagination for handling large result sets. The endpoint is particularly useful for reviewing upcoming maintenance schedules, auditing past maintenance windows, or integrating maintenance information into external systems or dashboards.Input Parameters
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.teams ability to use this parameter.Output
Retrieve notes for incident
Retrieve notes for incident
PAGERDUTY_RETRIEVE_NOTES_FOR_INCIDENTRetrieves all notes associated with a specific incident in PagerDuty. This endpoint allows users to access the complete history of comments, updates, and additional information added to an incident throughout its lifecycle. It is particularly useful for reviewing the incident’s progress, understanding the actions taken, and gathering context for post-incident analysis. The endpoint should be used when detailed information about an incident’s communication trail is needed, such as during incident reviews or when compiling reports. It does not provide real-time updates and may not include the most recent notes if called immediately after a new note is added due to potential API caching.Input Parameters
Output
Retrieve notifications
Retrieve notifications
PAGERDUTY_RETRIEVE_NOTIFICATIONSRetrieves a list of notifications sent to users in PagerDuty within a specified date range. This endpoint returns notifications that were delivered via email, SMS, phone, or push notifications for incidents, alerts, and other PagerDuty events. Use this to: - Track which users were notified about specific incidents - Audit notification delivery history - Monitor notification patterns and volume - Verify that critical alerts were properly communicated to on-call responders The endpoint requires a date range (must be less than 3 months) and supports filtering by notification type, pagination, and timezone specification. Note that there may be a slight delay between when a notification is sent and when it appears in the API results.Input Parameters
Output
Retrieve oncall handoff notification rule
Retrieve oncall handoff notification rule
PAGERDUTY_RETRIEVE_ONCALL_HANDOFF_NOTIFICATION_RULERetrieves detailed information about a specific on-call handoff notification rule for a given user in PagerDuty. This endpoint is crucial for managing and reviewing the notification settings that govern how users are alerted during on-call responsibility transitions. It provides access to the configuration of rules that determine when and how a user is notified about upcoming on-call shifts or handoffs. This tool should be used when there’s a need to inspect or audit the notification preferences for on-call transitions of a particular user. It’s particularly useful for team leads or administrators who need to ensure smooth handoffs between team members during critical incident management periods.Input Parameters
Output
Retrieve oncall handoff notification rules
Retrieve oncall handoff notification rules
PAGERDUTY_RETRIEVE_ONCALL_HANDOFF_NOTIFICATION_RULESRetrieves the on-call handoff notification rules for a specific user in PagerDuty. This endpoint allows you to fetch the configured rules that determine how and when a user is notified about on-call schedule transitions. It’s particularly useful for understanding and auditing a user’s notification preferences during shift changes or when responsibilities are transferred between team members. The retrieved rules may include settings for different notification methods (e.g., email, SMS, push notifications) and timing preferences relative to the handoff. This endpoint should be used when you need to review or manage a user’s on-call handoff communication settings, but it does not allow for modification of these rules.Input Parameters
Output
Retrieve oncall list
Retrieve oncall list
PAGERDUTY_RETRIEVE_ONCALL_LISTRetrieves the current on-call information for your PagerDuty account. This endpoint provides a comprehensive view of who is currently on-call across various schedules and escalation policies. It’s particularly useful for getting an overview of your organization’s current on-call status, identifying who is responsible for incident response at any given time, and planning team availability. The endpoint supports filtering by users, escalation policies, and schedules, making it versatile for different querying needs. It also allows for pagination and including additional details like contact methods and schedule information. This tool should be used when you need to quickly assess the current on-call situation or gather data for on-call analytics. Note that while it provides current and near-future on-call information, it may not be suitable for long-term scheduling or historical analysis beyond a 3-month window.Input Parameters
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.until time cannot be before the since time.null is provided in the array, it includes permanent on-calls due to direct user escalation targets.Output
Retrieve past incidents
Retrieve past incidents
PAGERDUTY_RETRIEVE_PAST_INCIDENTSRetrieves a list of past similar incidents for a specific incident using machine learning. This endpoint uses PagerDuty’s AIOps-powered Past Incidents feature to find historical incidents from the same service that are similar to the current incident. The similarity is determined by analyzing incident title semantics, responders, duration, and timing. Requirements: - Requires PagerDuty AIOps add-on subscription - The service must have AIOps enabled in its configuration Use Cases: - Identify recurring problems and patterns - Find similar historical incidents for context during incident response - Analyze incident patterns for root cause analysis - Learn from past incident resolutions Note: This endpoint returns ML-generated similar past incidents, not all past incidents. For retrieving all incidents, use the ‘Fetch incident list’ action instead.Input Parameters
false to provide faster response times. Set to true to populate the total count field.Output
Retrieve postmortem by id
Retrieve postmortem by id
PAGERDUTY_RETRIEVE_POSTMORTEM_BY_IDRetrieves the postmortem analysis for a specific post on a PagerDuty status page. This endpoint allows users to access detailed information about an incident after it has been resolved, including root cause analysis, timeline of events, and lessons learned. It should be used when detailed information about the resolution of a specific incident is needed, particularly for review, documentation, or improvement purposes. The endpoint is valuable for teams conducting thorough post-incident reviews or for maintaining a knowledge base of past incidents and their resolutions. Note that this endpoint only provides postmortem information and does not allow for modifications to the postmortem content.Input Parameters
Output
Retrieve response play by id
Retrieve response play by id
PAGERDUTY_RETRIEVE_RESPONSE_PLAY_BY_IDDEPRECATED: This endpoint has been deprecated and removed. Response Plays have been replaced by Incident Workflows. When calling this endpoint, the API returns HTTP 301 (Moved Permanently) with the error message: “Incident Workflows are enabled on this account.” Migration Path: Use Incident Workflows API instead: - List Incident Workflows: GET /incident_workflows - Get Incident Workflow: GET /incident_workflows/{id} Original Functionality: This endpoint previously retrieved detailed information about a specific response play in the PagerDuty incident management system, including configuration and actions for automating incident response processes. DEPRECATED: Response Plays are EOL. On accounts with Incident Workflows enabled this always fails; use the Incident Workflows actions instead.Input Parameters
Output
Retrieve rule by service id
Retrieve rule by service id
PAGERDUTY_RETRIEVE_RULE_BY_SERVICE_IDRetrieves a specific PagerDuty service event rule by service ID and rule ID, to review its conditions and actions or prepare for migration. DEPRECATED: Service Event Rules are legacy; their web pages have reached end of life, but rules remain accessible via API. PagerDuty recommends migrating to Event Orchestration.Input Parameters
Output
Retrieve ruleset by id
Retrieve ruleset by id
Retrieve ruleset list
Retrieve ruleset list
PAGERDUTY_RETRIEVE_RULESET_LISTRetrieves a list of rulesets from the PagerDuty system. Rulesets are collections of event rules that define how incidents are managed and alerts are configured. This endpoint allows you to view all available rulesets, which is crucial for understanding your incident management setup and making informed decisions about alert routing and event handling. Use this endpoint when you need to audit your ruleset configurations, prepare for modifications to your incident management workflow, or simply need an overview of your current ruleset structure. The response will include details about each ruleset, such as its name, ID, and potentially its associated rules, depending on the API version and configuration. This endpoint supports pagination to handle large numbers of rulesets efficiently.Input Parameters
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.Output
Retrieve rules for service id
Retrieve rules for service id
PAGERDUTY_RETRIEVE_RULES_FOR_SERVICE_IDLists a page of legacy Service Event Rules for a specified PagerDuty service, including rule conditions and actions. Pagination parameters allow retrieval of additional pages.Input Parameters
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.Output
Retrieve rules from ruleset by id
Retrieve rules from ruleset by id
PAGERDUTY_RETRIEVE_RULES_FROM_RULESET_BY_IDLists event rules in a specified legacy PagerDuty ruleset, including conditions, actions, ordering, and disabled status. Supports pagination; legacy event rules remain manageable through the API.Input Parameters
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.Output
Retrieve schedule audit records by id
Retrieve schedule audit records by id
PAGERDUTY_RETRIEVE_SCHEDULE_AUDIT_RECORDS_BY_IDRetrieves a page of audit records for a specific legacy PagerDuty schedule, with date-range and cursor filters. Records can include timestamps, actors, and change details.Input Parameters
limit parameter used in the request or the maximum request size of the API.now() - 24 hours (past 24 hours)now(). May not be more than 31 days after since.next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.Output
Retrieve schedule by id
Retrieve schedule by id
PAGERDUTY_RETRIEVE_SCHEDULE_BY_IDRetrieves detailed information about a specific schedule in PagerDuty using its unique identifier. This endpoint is essential for viewing the configuration of an existing on-call schedule, including its name, time periods, rotation layers, and associated users or teams. Use this when you need to inspect a schedule’s current setup, verify on-call assignments, or gather data for schedule management tasks. The endpoint provides a comprehensive view of a single schedule but does not allow modifications; for updates, a separate PUT request would be required.Input Parameters
overflow=true is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z: - If you don”t pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T10:00:00Z and end of 2011-06-01T14:00:00Z. - If you do pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.Output
Retrieve schedule override by id
Retrieve schedule override by id
PAGERDUTY_RETRIEVE_SCHEDULE_OVERRIDE_BY_IDLists all schedule overrides for a specific schedule within a date range. Schedule overrides are temporary modifications to the regular on-call rotation, allowing you to assign different users for specific time periods without changing the base schedule. Use this action to: - View all temporary schedule changes within a specific time period - Audit who was or will be on-call during override periods - Verify that schedule modifications have been correctly applied - Plan future on-call coverage by checking existing overrides The action returns a list of overrides, each containing the override ID, start/end times, and the user assigned during that period. You can filter results using optional parameters: ‘editable’ returns only future overrides that can be modified, and ‘overflow’ controls whether overrides extending beyond the date range are truncated or fully included. Note: This is a read-only operation - it does not create, modify, or delete overrides.Input Parameters
Output
Retrieve service audit records by id
Retrieve service audit records by id
PAGERDUTY_RETRIEVE_SERVICE_AUDIT_RECORDS_BY_IDRetrieves the audit records for a specific PagerDuty service. This endpoint allows you to fetch a historical log of all configuration changes made to the service, providing transparency and accountability in incident management processes. Use this endpoint when you need to review modifications, track who made changes, or investigate the evolution of a service’s configuration over time. The audit records are typically sorted by execution time from newest to oldest, offering a chronological view of alterations. While this endpoint is valuable for compliance and debugging purposes, it does not provide real-time incident data or current service configurations.Input Parameters
next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.Output
Retrieve service by id
Retrieve service by id
PAGERDUTY_RETRIEVE_SERVICE_BY_IDRetrieves detailed information about a specific PagerDuty service using its unique identifier. This endpoint allows users to access configuration details, integration settings, and other relevant information for a particular service within their PagerDuty account. It’s essential for managing and monitoring the status of individual services, which are core components in PagerDuty’s incident management system. Use this endpoint when you need to inspect or verify the configuration of a specific service, such as before making updates or troubleshooting issues related to that service. The endpoint provides a comprehensive view of the service but does not allow modifications; for updates, a separate PUT or PATCH endpoint would be required.Input Parameters
Output
Retrieve service change events by id
Retrieve service change events by id
PAGERDUTY_RETRIEVE_SERVICE_CHANGE_EVENTS_BY_IDRetrieves change events associated with a specific PagerDuty service. This endpoint allows you to fetch informational updates about recent changes such as code deploys, system configuration modifications, and other significant alterations related to the specified service. It’s particularly useful for tracking and auditing changes that might impact service performance or reliability. The endpoint should be used when you need to review the history of changes for a service, investigate potential causes of incidents, or maintain a log of service modifications for compliance purposes. Note that this endpoint focuses solely on change events and does not provide real-time incident data or service configuration details.Input Parameters
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.teams ability to use this parameter.Output
Retrieve service impacts from status dashboards
Retrieve service impacts from status dashboards
PAGERDUTY_RETRIEVE_SERVICE_IMPACTS_FROM_STATUS_DASHBOARDSRetrieves the service impacts associated with a specific status dashboard in PagerDuty. This endpoint allows users to fetch detailed information about how incidents are affecting various services within the context of a particular status dashboard. It should be used when there’s a need to assess the current operational status and impact of incidents on services for a given dashboard. The endpoint provides real-time insights into service disruptions, helping teams quickly identify and prioritize issues. Note that this endpoint only returns data for a single status dashboard at a time and does not provide historical impact data.Input Parameters
Output
Retrieve service status by id
Retrieve service status by id
PAGERDUTY_RETRIEVE_SERVICE_STATUS_BY_IDRetrieves a list of services associated with a specific status page in PagerDuty. This endpoint fetches all services that are being monitored and displayed on a particular status page. Status pages provide real-time visibility into service health and operational status. The response includes service details such as names, current statuses, and relevant metadata. Use this action when you need to: - Review which services are shown on a specific status page - Monitor the operational status of services on a status page - Integrate status page service information with external systems - Audit service visibility configurations Note: You must have access to the specified status page. Use the PAGERDUTY_FETCH_STATUS_PAGES action to get available status page IDs.Input Parameters
Output
Retrieve service status page
Retrieve service status page
PAGERDUTY_RETRIEVE_SERVICE_STATUS_PAGERetrieves detailed information about a specific service associated with a particular status page in PagerDuty. This endpoint is used to fetch the current status, configuration, and other relevant details of a service displayed on a status page. It’s particularly useful for monitoring the health and state of individual components within a larger system. The endpoint should be used when you need up-to-date information about a specific service’s status or when integrating PagerDuty’s status information into other monitoring or reporting tools. Note that this endpoint only provides information for services that are configured to be displayed on the specified status page.Input Parameters
Output
Retrieve standards list
Retrieve standards list
PAGERDUTY_RETRIEVE_STANDARDS_LISTRetrieves the current set of Service Standards defined in the PagerDuty account. Service Standards are configurable criteria that help organizations define, share, and track service configuration best practices. These standards ensure consistency across services and improve incident response predictability. Standards can check for various service attributes such as having descriptions, proper escalation policies, integrations, dependencies, and more. This endpoint returns standards that can be filtered by active status and resource type. Each standard includes details about what it checks, why it’s important, and which resources are included or excluded from its scope. Administrators and team leads use this to review and audit service configuration standards across their organization. Note: This endpoint is read-only and does not allow modification of standards.Input Parameters
Output
Retrieve standards scores by resource type and id
Retrieve standards scores by resource type and id
PAGERDUTY_RETRIEVE_STANDARDS_SCORESRetrieves the standards scores for a specific technical service in PagerDuty. Returns a detailed evaluation showing which PagerDuty best practices and standards the service meets, including whether it has proper descriptions, escalation policies, integrations, and service dependencies. Each standard includes a pass/fail status and explanation. Use this to assess service health, identify configuration gaps, and ensure services follow organizational best practices. The response includes a score summary (e.g., “passing 4 out of 9 standards”) and detailed results for each evaluated standard.Input Parameters
Output
Retrieve standards scores by resourcetype
Retrieve standards scores by resourcetype
Retrieve status dashboard by slug
Retrieve status dashboard by slug
PAGERDUTY_RETRIEVE_STATUS_DASHBOARD_BY_SLUGRetrieves a PagerDuty status dashboard by URL slug, including its ID, name and URL slug.Input Parameters
Output
Retrieve status dashboards information
Retrieve status dashboards information
Retrieve status page post
Retrieve status page post
PAGERDUTY_RETRIEVE_STATUS_PAGE_POSTLists posts on a PagerDuty status page, with optional filters for post type, review status and status IDs. Results may be paginated.Input Parameters
Output
Retrieve status page severities by id
Retrieve status page severities by id
PAGERDUTY_RETRIEVE_STATUS_PAGE_SEVERITIES_BY_IDLists severity levels configured for a PagerDuty status page, optionally filtered to incident or maintenance posts. Use the results to review the impact levels available for that page.Input Parameters
Output
Retrieve status pages status
Retrieve status pages status
Retrieve status page subscription by id
Retrieve status page subscription by id
Retrieve tag by id
Retrieve tag by id
Retrieve team audit records
Retrieve team audit records
PAGERDUTY_RETRIEVE_TEAM_AUDIT_RECORDSRetrieves the audit records for a specific team in PagerDuty. This endpoint allows users to access a detailed history of configuration changes made to the team, including modifications to team members, escalation policies, and other team-related settings. It’s particularly useful for security auditing, compliance reporting, and tracking the evolution of team structures over time. The endpoint returns a list of audit records, each likely containing information such as the type of change, who made the change, and when it occurred. Use this endpoint when you need to review or analyze the historical changes of a PagerDuty team’s configuration.Input Parameters
next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.Output
Retrieve team details by id
Retrieve team details by id
Retrieve team list
Retrieve team list
PAGERDUTY_RETRIEVE_TEAM_LISTThe ListTeams endpoint retrieves a list of teams within a PagerDuty account. It provides an overview of all teams or a filtered subset based on the optional query parameter. This endpoint is useful for obtaining team information, such as team names and IDs, which can be used in other API calls or for organizational purposes. The response typically includes basic details about each team, allowing for further actions or more detailed queries on specific teams. Use this endpoint when you need to survey the teams in your PagerDuty organization, prepare for team management tasks, or integrate team information into other systems. Note that while it returns a list of teams, it may not provide exhaustive details for each team; for comprehensive information on a specific team, a separate API call might be necessary.Input Parameters
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.Output
Retrieve technical service details
Retrieve technical service details
Retrieve template fields
Retrieve template fields
PAGERDUTY_RETRIEVE_TEMPLATE_FIELDSRetrieves the available field definitions for PagerDuty status update templates. This endpoint returns metadata about the fields that can be used when creating or modifying templates within the PagerDuty platform. Important: This endpoint requires PagerDuty’s Status Pages or Templates feature, which is typically available on Business or Enterprise plans. If the feature is not available on your account, the API will return a 402 Payment Required error. The endpoint is useful for: - Understanding available template field options before creating templates - Building interfaces for template management - Automating template creation with proper field validation - Documenting the template schema for your organization This is a read-only endpoint that does not modify any existing templates or create new ones; it only provides information about the available field definitions and their properties (such as field names, types, and descriptions).Output
Retrieve unrouted event orchestration by id
Retrieve unrouted event orchestration by id
PAGERDUTY_RETRIEVE_UNROUTED_EVENT_ORCHESTRATION_BY_IDRetrieves the unrouted orchestration configuration for a specific Event Orchestration in PagerDuty. The unrouted orchestration defines how events that don’t match any routing rules are handled - they can be suppressed or routed to specific services. This configuration includes rule sets, catch-all actions, and version information. Use this endpoint when you need to review or audit the unrouted event handling configuration, understand how unmatched events are processed, or before updating the unrouted orchestration rules. The endpoint returns the complete configuration including created/updated timestamps, user references, and the current version identifier. Note that this is a read-only endpoint for retrieving configuration - use the update endpoint to modify the unrouted orchestration settings.Input Parameters
Output
Retrieve user audit records by id
Retrieve user audit records by id
PAGERDUTY_RETRIEVE_USER_AUDIT_RECORDS_BY_IDRetrieves the audit records for a specific user in the PagerDuty system. This endpoint allows you to access a historical log of activities and changes associated with the user, providing valuable insights for compliance, security, and troubleshooting purposes. The audit records may include actions such as login attempts, configuration changes, and incident-related activities performed by or affecting the specified user. Use this endpoint when you need to investigate user activities, track changes, or generate reports for auditing and compliance requirements. Note that the response may be paginated, and additional query parameters might be available to filter or sort the results, although these are not explicitly defined in the given schema.Input Parameters
next_cursor field of the previous request. When no value is provided, the request starts at the beginning of the result set.Output
Retrieve user by id
Retrieve user by id
PAGERDUTY_RETRIEVE_USER_BY_IDRetrieves detailed information about a specific PagerDuty user by their ID. Returns user profile data including name, email, role, timezone, and other account details. Use the ‘include’ parameter to optionally fetch related resources like contact methods, notification rules, teams, or subdomains in the same request. Common use cases: - Get user profile information for display in applications - Verify user details before performing operations - Fetch user contact methods for notification purposes - Check user role and permissions Note: This endpoint does not return the user’s current on-call status or incident history. Use the on-calls or incidents endpoints for that information.Input Parameters
Output
Retrieve user contact methods via id
Retrieve user contact methods via id
PAGERDUTY_RETRIEVE_USER_CONTACT_METHODS_VIA_IDRetrieves the contact methods associated with a specific PagerDuty user, such as email addresses and phone numbers. Use it to review the contact information on file for incident notifications. This is a read-only operation and does not add, modify, or remove contact methods.Input Parameters
Output
Retrieve user license information
Retrieve user license information
PAGERDUTY_RETRIEVE_USER_LICENSE_INFORMATIONRetrieves the license information for a specific user in the PagerDuty system. This endpoint allows you to check the current licensing status, type, and any associated details for a given user. It should be used when you need to verify a user’s license, such as during account management or when troubleshooting access issues. The endpoint will return details about the user’s current license, but it does not provide information about other aspects of the user’s account or permissions. Keep in mind that access to this endpoint may be restricted to users with appropriate administrative privileges.Input Parameters
Output
Retrieve user notification rule
Retrieve user notification rule
PAGERDUTY_RETRIEVE_USER_NOTIFICATION_RULERetrieves a specific incident notification rule for a PagerDuty user, including its contact method reference, notification delay and urgency.Input Parameters
Output
Retrieve user notification rules
Retrieve user notification rules
PAGERDUTY_RETRIEVE_USER_NOTIFICATION_RULESRetrieves the notification rules for a specific user in PagerDuty. This endpoint allows you to fetch all configured notification rules associated with a given user, providing insight into how and when the user receives alerts for incidents. It’s particularly useful for auditing a user’s notification setup, troubleshooting notification issues, or programmatically managing user preferences. The endpoint returns a list of notification rules, likely including details such as contact methods, time-based restrictions, and urgency levels for each rule. It should be used when you need to review or analyze a user’s current notification configuration within your incident management workflow.Input Parameters
high.Output
Retrieve users by schedule id
Retrieve users by schedule id
PAGERDUTY_RETRIEVE_USERS_BY_SCHEDULE_IDRetrieves a list of users associated with a specific PagerDuty schedule. This endpoint is essential for managing on-call rotations and understanding who is responsible for incident response during different time periods. It should be used when you need to view all users assigned to a particular schedule, which is helpful for auditing, planning, or modifying on-call arrangements. The endpoint returns basic user information and does not provide detailed schedule timeslots or user availability. It’s particularly useful for larger teams with complex rotation schedules to ensure proper coverage and fair distribution of on-call responsibilities.Input Parameters
Output
Retrieve users list
Retrieve users list
PAGERDUTY_RETRIEVE_USERS_LISTRetrieves a list of users from the PagerDuty system. This endpoint allows you to fetch information about multiple users in your PagerDuty account, which can be useful for user management, generating reports, or integrating user data with other systems. The response typically includes basic information about each user, such as their ID, name, email, and role. Use query parameters to filter, paginate, or search for specific users. This endpoint is ideal for bulk operations or when you need an overview of your PagerDuty user base. Note that the results may be paginated, so multiple calls might be necessary to retrieve all users for large accounts.Input Parameters
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.teams ability to use this parameter.Output
Retrieve user status update notification rule
Retrieve user status update notification rule
PAGERDUTY_RETRIEVE_USER_STATUS_UPDATE_NOTIFICATION_RULERetrieves a specific status update notification rule for a given user in PagerDuty. This endpoint allows you to fetch detailed information about how and when a particular user receives notifications for status updates on incidents. It’s useful for auditing notification settings, troubleshooting notification issues, or programmatically managing user preferences. The endpoint should be used when you need to review or verify the configuration of a single notification rule for a specific user. It does not modify any settings and is read-only in nature.Input Parameters
Output
Retrieve vendor by id
Retrieve vendor by id
PAGERDUTY_RETRIEVE_VENDOR_BY_IDGet detailed information about a specific PagerDuty vendor integration by its ID. Returns vendor details including name, description, integration type, logo URLs, documentation links, and connection capabilities. Use this to verify vendor configuration or gather integration information before setting up services. Requires a valid vendor ID (e.g., ‘PZQ6AUS’ for AWS CloudWatch, ‘PAM4FGS’ for Datadog). Get vendor IDs by first calling the fetch vendor list action.Input Parameters
Output
Retrieve webhook subscriptions
Retrieve webhook subscriptions
PAGERDUTY_RETRIEVE_WEBHOOK_SUBSCRIPTIONSRetrieves a list of all webhook subscriptions associated with the authenticated PagerDuty account. This endpoint allows users to view and manage their existing webhook configurations, which are used to receive real-time notifications about incidents, alerts, and other PagerDuty events. It’s particularly useful for auditing current integrations, troubleshooting notification issues, or preparing to update webhook settings. The response likely includes details such as webhook URLs, event types they’re subscribed to, and their current status. This endpoint should be used when you need an overview of all active webhook integrations but won’t provide the actual event data sent to these webhooks.Input Parameters
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.Output
Send MCP request
Send MCP request
PAGERDUTY_SEND_MCP_REQUESTTool to send JSON-RPC requests to PagerDuty’s Model Context Protocol (MCP) endpoint. Use when you need to interact with MCP servers for tool execution, resource management, or prompt operations.Input Parameters
Output
Send responder requests for incidents
Send responder requests for incidents
PAGERDUTY_SEND_RESPONDER_REQUESTS_FOR_INCIDENTSSend responder requests to users or escalation policies for a PagerDuty incident. Use this action to request additional help for an ongoing incident by notifying specific users or escalation policies. This is useful when an incident requires more expertise, resources, or urgent attention beyond the currently assigned team. The responder request includes a message explaining why help is needed and allows you to target multiple responders at once (up to 500 unique responders and 1000 responder requests per incident). Note: This action requires a PagerDuty plan that includes the Add Responders feature.Input Parameters
Output
Set business service impact status
Set business service impact status
PAGERDUTY_SET_BUSINESS_SERVICE_IMPACT_STATUSThis endpoint updates the impact status of a specific incident on a particular business service in PagerDuty. It allows you to either set a business service as impacted by an incident or remove the impact, which in turn affects the propagation of the impact to other supported services. Use this endpoint when you need to manually adjust the impact of an incident on your business services, either to escalate its importance or to mark it as resolved for specific services. This tool is particularly useful for managing the scope and severity of incidents across your organization’s service hierarchy. Note that updating the impact status will have cascading effects on services supported by the targeted business service.Input Parameters
Output
Set global priority threshold
Set global priority threshold
PAGERDUTY_SET_GLOBAL_PRIORITY_THRESHOLDSets the global Priority Threshold for Business Services in PagerDuty, determining which incidents can impact these services based on their priority level. This endpoint allows you to configure the minimum incident priority required to affect Business Services by specifying an ‘id’ and ‘order’ for the threshold. Use this when you need to adjust how incidents of different priorities impact your Business Services. Note that incidents below this threshold won’t impact Business Services unless manually added using a separate endpoint. This configuration is crucial for managing service impacts and prioritizing incident responses effectively.Input Parameters
Output
Snooze incident by duration
Snooze incident by duration
PAGERDUTY_SNOOZE_INCIDENT_BY_DURATIONSnooze an acknowledged incident in PagerDuty for a specified duration. This temporarily suppresses notifications for the incident, automatically returning it to the “triggered” state when the snooze period expires. The incident must be in “acknowledged” status before snoozing. Use Cases: - Managing alert fatigue during investigation - Waiting for upstream dependencies to recover - Delaying notifications during maintenance windows - Handling known false positives that require time to verify Important Notes: - Snoozing does NOT resolve the incident - it only delays notifications - The incident will automatically re-trigger after the snooze duration - Reassigning a snoozed incident cancels the snooze timer - Maximum snooze duration is 1 week (604,800 seconds) Prerequisites: - Incident must be in “acknowledged” status (use update incident action first if needed) - User must have permission to modify the incidentInput Parameters
Output
Subscribe entities to business services
Subscribe entities to business services
PAGERDUTY_SUBSCRIBE_ENTITIES_TO_BUSINESS_SERVICESThis endpoint allows you to subscribe users or teams to a specific business service in PagerDuty. It enables you to add multiple subscribers in a single request, streamlining the process of setting up notification recipients for critical incidents. Use this endpoint when you need to configure who receives alerts and updates for a particular business service. The endpoint is particularly useful for initial setup or bulk updates to subscriber lists. Note that this operation adds new subscribers but does not remove existing ones; to remove subscribers, you would need to use a separate endpoint.Input Parameters
Output
Subscribe entities to incident status updates
Subscribe entities to incident status updates
PAGERDUTY_SUBSCRIBE_ENTITIES_TO_INCIDENT_STATUS_UPDATESSubscribes specified users or teams to receive status updates for a particular incident in PagerDuty. This endpoint allows you to add multiple subscribers at once, ensuring that relevant parties are kept informed about the incident’s progress. It’s particularly useful when you need to involve additional stakeholders or support teams during an ongoing incident. The endpoint requires the incident ID and a list of subscribers, each defined by their unique ID and type (user or team). Use this when you want to expand the notification list for critical updates about an incident, but be mindful not to oversubscribe, as it may lead to notification fatigue.Input Parameters
Output
Subscribe to user notifications
Subscribe to user notifications
PAGERDUTY_SUBSCRIBE_TO_USER_NOTIFICATIONSCreates notification subscriptions for a specific user in PagerDuty. This endpoint allows you to subscribe a user to multiple incidents or business services in a single API call. It’s particularly useful for setting up customized notification preferences for users, ensuring they receive alerts for specific entities they need to monitor. The endpoint supports bulk subscription, allowing you to subscribe a user to multiple entities simultaneously, improving efficiency in managing user notifications. Note that this endpoint only creates subscriptions and does not modify or delete existing ones.Input Parameters
Output
Unsubscribe business service entity
Unsubscribe business service entity
PAGERDUTY_UNSUBSCRIBE_BUSINESS_SERVICE_ENTITYThis endpoint unsubscribes specified users or teams from receiving notifications for a particular business service in PagerDuty. It allows bulk unsubscription of multiple entities in a single API call. The endpoint should be used when you need to remove one or more users or teams from the notification list of a specific business service, such as when reorganizing team responsibilities or updating notification preferences. It’s important to note that this action is immediate and irreversible, so care should be taken to ensure the correct entities are being unsubscribed. The endpoint doesn’t provide a way to confirm or preview the changes before they’re applied, so it’s recommended to double-check the subscriber information before making the API call.Input Parameters
Output
Unsubscribe from incident status updates
Unsubscribe from incident status updates
PAGERDUTY_UNSUBSCRIBE_FROM_INCIDENT_STATUS_UPDATESUnsubscribes specified users or teams from receiving status updates for a particular incident in PagerDuty. This endpoint is used when certain entities no longer need to be notified about changes to an incident’s status. It allows for bulk unsubscription of multiple users and/or teams in a single API call. The endpoint requires the incident ID in the URL path and a list of subscribers to unsubscribe in the request body. It’s important to note that this action cannot be undone through the API, and re-subscription would require a separate API call if needed later.Input Parameters
Output
Unsubscribe team notification subscriptions
Unsubscribe team notification subscriptions
PAGERDUTY_UNSUBSCRIBE_TEAM_NOTIFICATION_SUBSCRIPTIONSUnsubscribes a team from notifications for specific incidents or business services in PagerDuty. This endpoint is used to stop a team from receiving alerts and updates about particular entities. It’s particularly useful for managing notification overload or when a team is no longer responsible for certain incidents or services. The endpoint requires a list of subscribables (entities to unsubscribe from), each identified by a unique ID and type. At least one subscribable must be provided, and all items in the list must be unique. This operation cannot be undone through this endpoint, so use it cautiously.Input Parameters
Output
Unsubscribe user notification subscriptions
Unsubscribe user notification subscriptions
PAGERDUTY_UNSUBSCRIBE_USER_NOTIFICATION_SUBSCRIPTIONSThis endpoint allows unsubscribing a user from notifications for specific incidents or business services in PagerDuty. It’s used to modify a user’s notification preferences, removing them from receiving updates about particular entities. The endpoint accepts a list of subscribable entities, each identified by an ID and type, and removes the user’s subscription to these entities. This is particularly useful for managing notification overload or when a user no longer needs updates about certain incidents or services. The endpoint requires at least one subscribable entity and ensures that all entries in the request are unique.Input Parameters
Output
Update a custom field for an incident type
Update a custom field for an incident type
PAGERDUTY_UPDATE_A_CUSTOM_FIELD_FOR_AN_INCIDENT_TYPEUpdates a custom field for an incident type, including its display name, enabled status, default value, or description.Input Parameters
Output
Update add on by id
Update add on by id
PAGERDUTY_UPDATE_ADD_ON_BY_IDUpdates an existing Add-on in PagerDuty with new properties. This endpoint allows you to modify the type, name, and source URL of a specific Add-on identified by its unique ID. It’s used when you need to change the configuration or appearance of an Add-on that’s already integrated into your PagerDuty instance. The endpoint updates only the mutable fields and returns the full updated Add-on object, including read-only fields. Note that this operation cannot modify the Add-on’s ID or other system-generated fields like ‘summary’, ‘self’, or ‘html_url’.Input Parameters
Output
Update alert grouping settings byid
Update alert grouping settings byid
PAGERDUTY_UPDATE_ALERT_GROUPING_SETTINGS_BY_IDUpdate an existing Alert Grouping Setting in PagerDuty by its ID. Alert Grouping Settings control how alerts are automatically grouped into incidents, reducing noise and streamlining incident management. This endpoint allows you to modify: - Grouping type (time, intelligent, content_based, or content_based_intelligent) - Configuration parameters (time windows, field matching rules) - Associated services - Display name and description Important Notes: - This is a PUT request requiring the complete alert_grouping_setting object - Some grouping types (e.g., intelligent) may require specific PagerDuty plan features - The ‘content_based_intelligent’ type only supports one service per setting - Time windows must be 300-3600 seconds (or 86400 for content_based only) - Only include writable fields; omit read-only fields (id, created_at, updated_at) Use this when: You need to change how alerts are grouped for specific services, adjust time windows, or modify field-based grouping rules.Input Parameters
Output
Update alert in incident
Update alert in incident
PAGERDUTY_UPDATE_ALERT_IN_INCIDENTUpdates the status of a specific alert within an incident in PagerDuty. This endpoint allows you to modify an alert’s status, primarily to mark it as resolved. It’s crucial for managing the lifecycle of alerts and incidents in PagerDuty’s incident management system. Use this when you need to programmatically update the state of an alert, typically as part of an automated incident resolution process or when integrating external systems with PagerDuty. Note that while the endpoint accepts various fields in the request body, most are read-only, with the ‘status’ field being the primary modifiable attribute.Input Parameters
Output
Update an incident type
Update an incident type
Update incident workflow trigger
Update incident workflow trigger
Update automation runner info
Update automation runner info
PAGERDUTY_UPDATE_AUTOMATION_RUNNER_INFOThis endpoint allows you to update an existing Automation Action Runner in PagerDuty. It is used to modify the properties of a runner, such as its name, description, and, for runbook runners, the runbook server connection details. The endpoint supports updating both sidecar and runbook type runners, distinguished by the ‘runner_type’ discriminator. Use this endpoint when you need to change the configuration of an existing runner, such as updating its name for better identification or modifying the runbook server details. Note that while you can update most properties, you cannot change a runner’s type (e.g., from sidecar to runbook) using this endpoint.Input Parameters
Output
Update business service by id
Update business service by id
PAGERDUTY_UPDATE_BUSINESS_SERVICE_BY_IDThis endpoint allows you to update an existing Business Service in PagerDuty. It is used to modify the details of a specific service, such as its name, description, point of contact, or the team responsible for it. This is particularly useful when service information changes or when reassigning responsibilities within your organization. The endpoint requires the unique identifier of the Business Service and accepts a JSON object with the updated information. It’s important to note that you only need to include the fields you want to update; omitted fields will retain their current values.Input Parameters
Output
Update change event by ID
Update change event by ID
PAGERDUTY_UPDATE_CHANGE_EVENT_BY_IDUpdate an existing change event in PagerDuty by its unique ID. Modify summary, source, custom_details, or links for change events tracking deployments, configuration changes, or system modifications. Updatable fields: summary, source, custom_details, links (each replaces existing value) Read-only fields: id, type, timestamp, service, integration Requirements: PagerDuty AIOps add-on, change_events:write scope Use to correct typos, update metadata, add context, or replace documentation links. All updates replace existing field values entirely (no merging).Input Parameters
Output
Update Custom Field Display Name
Update Custom Field Display Name
PAGERDUTY_UPDATE_CUSTOM_FIELD_DISPLAY_NAMEUpdates an existing custom field for incidents in PagerDuty. This endpoint allows you to modify the display name, description, and default value of a custom field identified by its unique field_id. Use this action when you need to change the properties of a custom field, such as renaming it, updating its description, or setting a new default value. Prerequisites: 1. A valid custom field ID (use PAGERDUTY_RETRIEVE_INCIDENT_CUSTOM_FIELDS to list available fields) 2. At least one field property to update (display_name, description, or default_value) Important Notes: - Updating a custom field affects all incidents that use this field - The display_name must be unique across the account - Use this endpoint cautiously in production environments - Requires the custom_fields.write OAuth scopeInput Parameters
Output
Update custom field option
Update custom field option
PAGERDUTY_UPDATE_CUSTOM_FIELD_OPTIONUpdates the value or data type of an existing custom field option on a PagerDuty incident type, identified by the incident type, field, and option.Input Parameters
Output
Update escalation policy by id
Update escalation policy by id
PAGERDUTY_UPDATE_ESCALATION_POLICY_BY_IDUpdates an existing PagerDuty escalation policy by ID, including its name, description, escalation rules, team, looping, and on-call handoff notification settings.Input Parameters
Output
Update escalation policy for team
Update escalation policy for team
PAGERDUTY_UPDATE_ESCALATION_POLICY_FOR_TEAMAssociates an escalation policy with a team in PagerDuty. This creates or updates the link between a team and an escalation policy, enabling the team to use that policy for incident management. When an escalation policy is added to a team, the users, schedules, and services associated with that policy are also added to the team. Note: This does NOT modify the escalation policy’s configuration itself (like notification rules or escalation steps). To update the policy configuration, use the update_escalation_policy_by_id action instead. This action only manages the team-policy association. Important: An escalation policy can only be associated with one team at a time. The account must have the Teams feature enabled (typically requires a paid plan).Input Parameters
Output
Update event orchestration by id
Update event orchestration by id
PAGERDUTY_UPDATE_EVENT_ORCHESTRATION_BY_IDUpdates an existing Event Orchestration in PagerDuty. This endpoint allows you to modify the name, description, and team ownership of a specific Orchestration identified by its ID. It’s used to refine and adjust your incident management workflow by updating the configuration of how events are processed and routed. This tool is particularly useful when you need to change the purpose, ownership, or details of an Orchestration without creating a new one. Note that certain properties like integrations, routing information, and timestamps are read-only and cannot be modified through this endpoint. Use this when you need to update an Orchestration’s metadata or reassign it to a different team.Input Parameters
Output
Update Event Orchestration Cache Variable
Update Event Orchestration Cache Variable
PAGERDUTY_UPDATE_EVENT_ORCHESTRATION_CACHE_VARIABLEThis endpoint updates a cache variable associated with a specific service in PagerDuty’s event orchestrations. It allows you to modify the cache variable’s name, configuration, conditions, and disabled state. Use this endpoint when you need to change how a cache variable behaves, such as updating its value extraction method or trigger event count settings. The endpoint is particularly useful for fine-tuning event processing rules and maintaining dynamic incident management workflows. Note that some fields like ID, creation date, and last update information are read-only and cannot be modified through this endpoint.Input Parameters
_reference if the object is a reference._reference if the object is a reference.Output
Update event rule by id
Update event rule by id
PAGERDUTY_UPDATE_EVENT_RULE_BY_IDUpdates an existing Event Rule in a PagerDuty Ruleset, including its matching conditions, actions, position, active status, and time frame. Event Rules are legacy and remain manageable through the API.Input Parameters
Output
Update event rule for service
Update event rule for service
PAGERDUTY_UPDATE_EVENT_RULE_FOR_SERVICEUpdates an existing PagerDuty Service Event Rule, including its conditions, time restrictions, extraction variables, actions, position, or disabled state. Service Event Rules are legacy and remain manageable through the API.Input Parameters
Output
Update extension by id
Update extension by id
PAGERDUTY_UPDATE_EXTENSION_BY_IDUpdates an existing extension in PagerDuty. This endpoint allows you to modify the configuration of a previously created extension, such as a webhook or custom integration. You can update properties like the extension’s name, endpoint URL, associated objects, and custom configuration. This is useful for maintaining and adjusting integrations as your operational needs change. The endpoint requires the extension’s ID in the URL path and accepts a JSON payload with the updated extension details. It’s important to note that some fields, like the extension’s ID and type, are read-only and cannot be modified through this endpoint.Input Parameters
Output
Update the global orchestration for an event orchestration
Update the global orchestration for an event orchestration
PAGERDUTY_UPDATE_GLOBAL_ORCHESTRATIONUpdate the Global Orchestration configuration for an Event Orchestration. This action allows you to update global-level event routing rules and processing logic that apply to all events sent to an orchestration before they reach service-specific rules. The orchestration_path must include: - ‘sets’: A list of rule sets (at least one with id=‘start’). Each set contains: - ‘id’: Unique identifier for the set (first set must be ‘start’) - ‘rules’: List of rules, each with optional ‘conditions’ and ‘actions’ - ‘catch_all’: Fallback actions object applied when no rules match (must have ‘actions’ key) Rule actions can include: route_to, severity, priority, annotate, suppress, suspend, etc. Use the get_event_orchestration_global action first to retrieve the current configuration, then modify and send it back to update. For more information see the API Concepts Document Scoped OAuth requires: event_orchestrations.writeInput Parameters
Output
Update incident alerts
Update incident alerts
PAGERDUTY_UPDATE_INCIDENT_ALERTSThis endpoint allows you to update the status of multiple alerts associated with a specific incident in PagerDuty. It is particularly useful for bulk operations when you need to resolve or update the status of several alerts simultaneously within the context of a single incident. The endpoint accepts an array of alert objects, each containing the necessary information for the update. It’s important to note that this endpoint modifies existing alerts and cannot be used to create new alerts or incidents. Use this when you need to efficiently manage and update the state of multiple alerts tied to an ongoing incident.Input Parameters
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.Output
Update incident by id
Update incident by id
PAGERDUTY_UPDATE_INCIDENT_BY_IDUpdates an existing PagerDuty incident by ID, including its status, assignments, escalation level, urgency, title, incident type, or conference bridge.Input Parameters
Output
Update incident custom field values
Update incident custom field values
PAGERDUTY_UPDATE_INCIDENT_CUSTOM_FIELD_VALUESUpdates custom field values for a specific PagerDuty incident, overwriting specified values. Custom fields can hold metadata such as environment, severity, version information, and runbook links.Input Parameters
Output
Update incident details
Update incident details
PAGERDUTY_UPDATE_INCIDENT_DETAILSThis endpoint allows for bulk updating of multiple PagerDuty incidents in a single API call. It can be used to modify various attributes of incidents such as status, priority, assignments, and more. This is particularly useful for automating incident management processes, batch resolving or acknowledging incidents, or updating incident details en masse. The endpoint accepts an array of incident objects, each containing the necessary updates, allowing for efficient management of multiple incidents simultaneously. It’s important to note that while many fields are optional, each incident object must include the ‘id’ and ‘type’ fields for proper identification and processing.Input Parameters
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.Output
Update incident workflow
Update incident workflow
PAGERDUTY_UPDATE_INCIDENT_WORKFLOWThis endpoint updates an existing Incident Workflow in PagerDuty by its unique identifier. It allows you to modify various aspects of the workflow, including its name, description, associated team, and the sequence of steps to be executed during an incident. The primary use case is to refine or adjust incident response processes by altering the workflow’s configuration. This is particularly useful when incident management practices need to be updated based on new requirements or lessons learned from previous incidents. The endpoint provides granular control over each step in the workflow, allowing for precise tuning of automated actions and their inputs. However, it’s important to note that modifying a workflow may impact ongoing or future incident responses, so changes should be made thoughtfully and tested thoroughly before implementation in a production environment.Input Parameters
Output
Update integration by id and integration id
Update integration by id and integration id
PAGERDUTY_UPDATE_INTEGRATION_BY_ID_AND_INTEGRATION_IDUpdates an existing integration for a specific PagerDuty service. This endpoint allows you to modify the configuration of an integration, including its type, name, and various settings related to email processing for email-based integrations. It’s particularly useful for adjusting how incoming data (especially emails) is processed and turned into incidents. Use this endpoint when you need to change the behavior of an existing integration, such as updating email parsing rules, changing incident creation criteria, or modifying email filters. The endpoint requires the service ID and integration ID in the URL path, and expects a comprehensive integration object in the request body. Note that some fields like ‘id’, ‘created_at’, and ‘html_url’ are read-only and cannot be modified through this endpoint.Input Parameters
Output
Update integration label
Update integration label
PAGERDUTY_UPDATE_INTEGRATION_LABELThis endpoint updates the label (name) of an integration associated with a specific event orchestration in PagerDuty. It allows users to rename integrations for better organization and clarity within their incident management workflow. The endpoint should be used when there’s a need to change how an integration is identified within the PagerDuty system, such as after a service rename or to improve naming conventions. It’s important to note that this endpoint only updates the label of the integration and does not modify any other properties or configurations of the integration or event orchestration.Input Parameters
Output
Update log entry channel
Update log entry channel
PAGERDUTY_UPDATE_LOG_ENTRY_CHANNELUpdates collaboration channel information for a specific log entry in PagerDuty. This endpoint is specifically designed for updating details of Slack, Microsoft Teams, or Zoom channels that were created when responders were added to an incident. Use this to correct or update channel URLs, names, or other channel-specific metadata after the channel has been created. Important: This endpoint only works with log entries that have integration channels (Slack/Teams/Zoom). It cannot be used on standard log entries like triggers, acknowledgements, or website actions. The channel type cannot be changed - it must match the existing type and is required for validation. Common use case: After a Slack channel is created for incident collaboration, use this endpoint to update the channel URL or other details if they need correction.Input Parameters
Output
Update maintenance window by id
Update maintenance window by id
PAGERDUTY_UPDATE_MAINTENANCE_WINDOW_BY_IDUpdates an existing maintenance window in PagerDuty’s incident management system. This endpoint allows you to modify the details of a scheduled maintenance period, including its start and end times, affected services, and description. It’s used to adjust planned maintenance activities, ensuring that incidents are not created for specified services during the defined timeframe. The endpoint requires the maintenance window’s unique ID and accepts a JSON object with the updated information. It’s particularly useful for extending or shortening maintenance periods, changing the list of affected services, or updating the window’s description in response to changing maintenance requirements.Input Parameters
Output
Update oncall handoff notification rule
Update oncall handoff notification rule
PAGERDUTY_UPDATE_ONCALL_HANDOFF_NOTIFICATION_RULEUpdates a user’s on-call handoff notification rule, including its notification advance time, handoff type, and contact method. The contact method is required, and the handoff type defaults to both when omitted.Input Parameters
Output
Update orchestration router details
Update orchestration router details
PAGERDUTY_UPDATE_ORCHESTRATION_ROUTER_DETAILSUpdates the configuration of an existing Event Orchestration Router in PagerDuty. This endpoint allows you to modify the rules and routing logic for incoming events, determining how they are directed to specific services. It’s used to refine and adjust your incident management workflow by updating conditions, actions, and catch-all behavior for event routing. The update is comprehensive, meaning any omitted rules or details will be deleted from the existing configuration. Use this endpoint when you need to make changes to your event routing strategy or when adding new services or conditions to your orchestration setup.Input Parameters
Output
Update response play by id
Update response play by id
PAGERDUTY_UPDATE_RESPONSE_PLAY_BY_IDUpdates a legacy PagerDuty Response Play by ID, including its name, team, notification messages, runnability, or conference details. Response Plays package incident actions for use during incident response. DEPRECATED: PagerDuty removed the update endpoint; use Incident Workflows instead.Input Parameters
Output
Update ruleset by id
Update ruleset by id
Update schedule by id
Update schedule by id
PAGERDUTY_UPDATE_SCHEDULE_BY_IDThe UpdateSchedule endpoint modifies an existing on-call schedule in PagerDuty. It updates the schedule’s name, time zone, description, and layers. Each layer defines a rotation pattern for on-call duties. Use this to adjust rotations, add/remove users, change time zones, or modify restrictions. The API requires type and time_zone in the schedule object. Schedule layers are optional. When supplied, each layer must include its start, users, virtual rotation start, and rotation turn length.Input Parameters
overflow=true is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z: - If you don”t pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T10:00:00Z and end of 2011-06-01T14:00:00Z. - If you do pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.Output
Update service by id
Update service by id
PAGERDUTY_UPDATE_SERVICE_BY_IDUpdates an existing service in PagerDuty with the provided configuration. This endpoint allows you to modify various aspects of a service, such as its name, description, escalation policy, incident urgency rules, and alert grouping settings. Use this when you need to change the behavior or properties of an existing service. The endpoint requires the service ID and accepts a ‘service’ object containing the updated configuration. Note that some properties (like ‘id’ and ‘created_at’) are read-only and cannot be modified. Certain advanced features, such as alert grouping and auto-pause notifications, may only be available on specific PagerDuty plans.Input Parameters
Output
Update service orchestration active status
Update service orchestration active status
PAGERDUTY_UPDATE_SERVICE_ORCHESTRATION_ACTIVE_STATUSUpdate the active status of a service orchestration in PagerDuty. This endpoint enables or disables event orchestration for a specific service. When orchestration is active (true), incoming events are processed through the service’s orchestration rules. When inactive (false), events bypass orchestration and use the service’s default incident creation behavior. Common use cases: - Temporarily disable orchestration during maintenance windows - Enable orchestration after configuring new rules - Troubleshoot event routing by toggling orchestration on/off Requirements: - Valid service_id with an existing service orchestration - API token with write permissions (services.write scope) - The service must have orchestration configured Important: Disabling orchestration affects how events are routed and incidents are created for this service. Test changes in a development environment first when possible. Scoped OAuth required: services.writeInput Parameters
Output
Update standard by id
Update standard by id
PAGERDUTY_UPDATE_STANDARD_BY_IDUpdates an existing standard in the PagerDuty incident management platform. This endpoint allows you to modify various attributes of a standard, including its active status, filtering criteria, description, and the technical services it applies to. Use this when you need to adjust the scope or behavior of an existing standard, such as enabling or disabling it, refining its application using regex patterns, or updating the list of included or excluded services. The changes made through this endpoint will affect how the standard is applied to your incident management processes, potentially impacting alerting and response workflows for the associated services.Input Parameters
Output
Update status page post
Update status page post
PAGERDUTY_UPDATE_STATUS_PAGE_POSTUpdates an existing status page post update with new information. This endpoint modifies a specific update within a status page post, allowing you to change the message content, status (e.g., investigating, identified, monitoring, resolved), severity level, impacted services, and notification preferences. Use this to communicate progress on an ongoing incident or maintenance event. For example, you might update a post to change status from ‘investigating’ to ‘identified’ as you learn more about an issue, or update the message with new information about a fix being deployed. Required path parameters: - id: Status page ID (get from PAGERDUTY_FETCH_STATUS_PAGES) - post_id: Post ID (get from PAGERDUTY_CREATE_OR_UPDATE_STATUS_PAGE_POST) - post_update_id: Update ID (get from PAGERDUTY_CREATE_OR_UPDATE_STATUS_PAGE_POST_UPDATE_INFORMATION) The post_update object must include: message, status ID, severity ID, impacted services list, update frequency, notify_subscribers flag, and type field.Input Parameters
Output
Update status page post info
Update status page post info
PAGERDUTY_UPDATE_STATUS_PAGE_POST_INFOAdds a post update to an existing PagerDuty status page post. The update can include a message, status, severity, impacted services, expected update frequency, and subscriber notification settings.Input Parameters
Output
Update status page post postmortem
Update status page post postmortem
PAGERDUTY_UPDATE_STATUS_PAGE_POST_POSTMORTEMLegacy duplicate of create_or_update_status_page_postmortem. Both actions use the same PUT endpoint, which creates or replaces a postmortem for a Status Page Post. Use create_or_update_status_page_postmortem instead.Input Parameters
Output
Update status page post resource
Update status page post resource
PAGERDUTY_UPDATE_STATUS_PAGE_POST_RESOURCEUpdates an existing status page post on a PagerDuty Status Page. Modify post details like title, type (incident/maintenance), and timing. Required fields: type, title, post_type, and status_page reference. For ‘maintenance’ posts, starts_at and ends_at are REQUIRED; for ‘incident’ posts, they should be null/omitted. Use this to update ongoing incidents or adjust maintenance windows. Note: This updates post metadata, not status updates within the post.Input Parameters
Output
Update team by id
Update team by id
PAGERDUTY_UPDATE_TEAM_BY_IDUpdates an existing team in PagerDuty by modifying its name, description, visibility, or parent team. You can update: - name: Change the team name (must be unique) - description: Update team purpose/responsibilities - default_role: Change team visibility (‘none’ for private, ‘manager’ for public) - parent: Modify team hierarchy (requires Team Hierarchy feature) Provide only the fields you want to change. Other fields remain unchanged. Read-only fields like ‘id’, ‘summary’, ‘self’, and ‘html_url’ cannot be modified. Examples: - Rename: {“id”: “PXXXXXX”, “team”: {“name”: “New Team Name”}} - Make private: {“id”: “PXXXXXX”, “team”: {“default_role”: “none”}} - Update multiple: {“id”: “PXXXXXX”, “team”: {“name”: “Updated Team”, “description”: “New description”, “default_role”: “manager”}} Use this when reorganizing teams, changing visibility, or updating team information.Input Parameters
Output
Update template by id
Update template by id
PAGERDUTY_UPDATE_TEMPLATE_BY_IDThe UpdateTemplate endpoint allows you to modify an existing status update template in PagerDuty. This tool is used to customize notification templates for incident status updates, enabling consistent and efficient communication during incident management. It supports updating various aspects of the template, including its name, description, and content for different notification channels such as email and SMS. This endpoint is particularly useful when you need to refine or adjust your communication strategy for incident updates. Note that while you can update multiple fields, you cannot change the template type from ‘status_update’, as it’s currently the only supported type.Input Parameters
status_update is the only supported template at this time)Output
Update the service orchestration for a service
Update the service orchestration for a service
PAGERDUTY_UPDATE_THE_SERVICE_ORCHESTRATION_FOR_A_SERVICEUpdate a Service Orchestration for a service. Service Orchestrations allow you to create Event Rules that evaluate and process events sent to this service. The orchestration_path parameter must include: - ‘sets’: List of rule sets (at least one with id=‘start’). Each set has ‘id’ and ‘rules’ list. - ‘catch_all’: Actions object for unmatched events (must have ‘actions’ key). Rules can have ‘conditions’ and ‘actions’ (severity, priority, annotate, suppress, event_action, etc.). Get current config first using get_the_service_orchestration_for_a_service, then modify and update. Scoped OAuth requires: services.writeInput Parameters
Output
Update unrouted orchestration rules
Update unrouted orchestration rules
PAGERDUTY_UPDATE_UNROUTED_ORCHESTRATION_RULESUpdates the unrouted orchestration rules for a specific Event Orchestration in PagerDuty. This endpoint allows you to define how events that don’t match any service-specific rules should be handled. It’s used to create a fallback mechanism for event routing and manipulation, ensuring that all incoming events are processed appropriately. The update is comprehensive, meaning any omitted rules or rule details from the request will be deleted from the existing configuration. Use this endpoint when you need to modify the global handling of unrouted events, such as changing default severities, updating event summaries, or implementing new routing logic for unmatched events.Input Parameters
Output
Update user information
Update user information
PAGERDUTY_UPDATE_USER_INFORMATIONUpdates an existing user’s information in PagerDuty. Modifies user profile attributes including name, email, time zone, role, job title, description, color, and license. Only include fields you want to update in the user object - all fields are optional. Updatable fields: name, email, role, time_zone, job_title, description, color, license Read-only fields (use dedicated endpoints): teams, contact_methods, notification_rules Note: Only include fields you want to change. Some roles require specific account abilities.Input Parameters
Output
Update user status update notification rule by id
Update user status update notification rule by id
PAGERDUTY_UPDATE_USER_NOTIFICATION_RULE_BY_IDUpdates a specific status update notification rule for a PagerDuty user. This endpoint modifies how a user receives notifications about status updates on incidents they’re subscribed to (as stakeholders, not as assigned responders). It allows you to change the contact method (email, phone, SMS, or push notification) for receiving these status updates. Note: This is for status update notifications, which are different from incident assignment notifications. Status updates notify subscribers about changes to incidents they’re following. The contact method must already exist for the user before it can be associated with a notification rule. Use the user contact methods endpoints to manage available contact methods.Input Parameters
Output
Update user role on team
Update user role on team
PAGERDUTY_UPDATE_USER_ROLE_ON_TEAMAdds a user to a team or updates their role on a team. This endpoint manages team membership by assigning users to teams with specific roles. Use this to: - Add a new user to a team with a specified role - Update an existing team member’s role (promote/demote) - Change a user’s team permissions and responsibilities The role determines the user’s access level within the team context: - ‘manager’: Can manage team settings, members, and associated resources - ‘responder’: Can respond to incidents assigned to the team - ‘observer’: Read-only access to team resources Note: This affects only the user’s role for the specified team and does not modify their global account permissions or roles in other teams. Requires the Teams feature which is available on paid PagerDuty plans.Input Parameters
Output
Update workflow integration connection
Update workflow integration connection
PAGERDUTY_UPDATE_WORKFLOW_INTEGRATION_CONNECTIONUpdate an existing Workflow Integration Connection. Updates properties of a workflow integration connection such as name, service URL, authentication settings, and team permissions. This action is idempotent - sending the same update multiple times produces the same result. Scoped OAuth requires: workflow_integrations:connections.write