PagerDuty helps you proactively manage your digital operations by collecting data signals from anywhere, interpreting those signals using machine learning, automatically engaging the right people, and accelerating resolution and learning.
1Open Slashspace and go to Settings, then Connectors.
2On Discover, search for PagerDuty and click Connect.
3Sign in to PagerDuty in your browser. Slashspace updates when the account is connected.
Then ask for what you need in any Agent mode chat. PagerDuty is on in every chat unless you switch it off.
What your chats can do
356 tools from 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.
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.
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.
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.
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.
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.
Convert service rule by idConverts a service's Event Rules to Event Orchestration rules. This migration endpoint automatically converts Service Event Rules to the newer Event Orchestration format, identically re-creating existing rules while retaining the same behavior. Note: Event Rules reached end-of-life in January 2025. This endpoint migrates from legacy Event Rules to Event Orchestration. Important: Conversion does NOT automatically enable Event Orchestration. You must manually enable it in the service Settings or via API for rules to take effect. Safe to run multiple times - returns existing orchestration URL if already converted. Works even when service has no event rules (returns success with orchestration URL).
Count paused incident reportsRetrieves the count of paused incident reports in the PagerDuty system. This endpoint is part of PagerDuty's Incident Management and Analytics features, providing a quick way to quantify the number of incidents that are currently in a paused state. It's particularly useful for generating high-level analytics, tracking incident management efficiency, and identifying trends in incident handling. The endpoint returns a simple count, making it ideal for dashboard displays or periodic system status checks. It should be used when a rapid overview of paused incidents is needed, but it won't provide detailed information about individual incidents.
Create a custom field for an incident typeCreate a Custom Field for an Incident Type. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. Scoped OAuth requires: `custom_fields.write`
Create a field option for a custom fieldCreates a new field option for a custom field on an incident type. Field options represent the allowed values for multi-value or dropdown custom fields. Before using this action: 1. You need a valid incident type ID or name (use LIST_INCIDENT_TYPES to find one) 2. The incident type must have a custom field already created (use CREATE_A_CUSTOM_FIELD_FOR_AN_INCIDENT_TYPE) 3. The custom field should be of type 'multi_value' or 'multi_value_fixed' to support multiple options Use this action to add selectable options to custom fields, enabling users to choose from predefined values when categorizing or tagging incidents. Note: This is an Early Access endpoint that requires the X-EARLY-ACCESS header and the 'custom_fields.write' scope.
Create an incident typeCreate a new incident type. Incident Types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidentType) Scoped OAuth requires: `incident_types.write`
Create incident workflow triggerCreates a new incident workflow trigger in PagerDuty. Triggers define when and how incident workflows are activated - either automatically based on conditions or manually by responders. Trigger types: 'manual' (started by responders) or 'conditional' (fires when conditions are met, e.g., "incident.priority matches 'P1'"). Conditional triggers require a PCL condition string. Specify either a services list or subscribed_to_all_services (not both). Manual triggers support permission restrictions. Requires incident_workflows.write OAuth scope.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Create maintenance window objectCreates a new maintenance window in PagerDuty, allowing you to schedule periods of planned maintenance for specific services. During a maintenance window, incidents are not created for the affected services, preventing unnecessary alerts and notifications. This endpoint is useful for planning and executing system upgrades, patches, or other maintenance tasks without triggering false alarms. The maintenance window has a defined start and end time, can be associated with multiple services, and optionally linked to specific teams. It's important to note that while incidents are suppressed during the maintenance window, underlying issues are still logged and can be reviewed later if needed.
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.
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.
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.
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.
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.
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.
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.
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.
Create statuspage 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.
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.
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.
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.
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.
Create workflow integration connectionCreate a new Workflow Integration Connection. Scoped OAuth requires: `workflow_integrations:connections.write`
Delete account subscription by idDeletes the account subscription associated with a specific business service in PagerDuty. This endpoint is used to terminate the subscription or billing relationship between a business service and the account. It should be used when you need to discontinue the subscription for a particular business service, such as when the service is no longer needed or when restructuring your PagerDuty setup. This action is irreversible, so it should be used with caution. The endpoint does not return any specific data upon successful deletion, likely providing only a success status code.
Delete a custom field for an incident typeDeletes a custom field from an incident type. This permanently removes the field definition and associated options, but does not affect historical data on existing incidents. Prerequisites: 1. Valid incident type ID or name (use LIST_INCIDENT_TYPES) 2. Custom field on that incident type (use LIST_INCIDENT_TYPE_CUSTOM_FIELDS) 3. API token with 'custom_fields.write' scope Note: Early Access endpoint requiring X-EARLY-ACCESS header with 'analytics-v2'. Use case: Remove deprecated fields or clean up test fields. Scoped OAuth requires: `custom_fields.write`
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.
Delete a field option for a custom fieldDeletes a specific field option from a custom field on an incident type. Field options represent the allowed values for multi-value or dropdown custom fields. This action permanently removes a field option. If incidents are using this field option value, the behavior depends on PagerDuty's configuration for handling deleted options. Prerequisites: 1. A valid incident type ID or name (use LIST_INCIDENT_TYPES to find one) 2. A custom field on that incident type (use LIST_INCIDENT_TYPE_CUSTOM_FIELDS) 3. A field option on that custom field (use LIST_FIELD_OPTIONS_ON_A_CUSTOM_FIELD) Note: This is an Early Access endpoint that requires the X-EARLY-ACCESS header with 'analytics-v2' and the 'custom_fields.write' scope. Example use case: Remove an obsolete option from a severity or category dropdown field after it's no longer needed for incident classification.
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.
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.write`
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.
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.
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.
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.
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.
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 above
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.
Delete custom field by field idDeletes a specific custom field from incidents in PagerDuty. This endpoint allows users to remove a custom field that is no longer needed or relevant for incident management. It should be used when you want to permanently delete a custom field from all incidents, both existing and future. The operation is irreversible, so caution should be exercised when using this endpoint. It's important to note that this action will remove the specified custom field and its associated data from all incidents, which could impact reporting and analysis based on that field.
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.
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.
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.
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.
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.
Delete incident workflow trigger by idDeletes a specific trigger associated with an incident workflow in PagerDuty. This endpoint is used to remove an automated trigger that initiates a predefined workflow in response to incidents. It should be used when you need to modify your incident response automation by removing outdated or unnecessary triggers. This operation is permanent and cannot be undone, so it should be used with caution. The endpoint does not return any data upon successful deletion, typically responding with a 204 No Content status.
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 scope
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.
Delete maintenance window by idDeletes a specific maintenance window in PagerDuty's incident management system. This endpoint is used to permanently remove a scheduled maintenance window, effectively re-enabling any services and integrations that were temporarily disabled during the maintenance period. It should be used when a maintenance window is no longer needed or was created in error. Once deleted, the maintenance window cannot be recovered, so caution should be exercised when using this endpoint. This operation is particularly useful for cleaning up obsolete maintenance windows or adjusting scheduled maintenance plans.
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.
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.
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.
Delete rule from ruleset by idDeletes a specific event rule from a ruleset in PagerDuty. This endpoint permanently removes an individual rule from the specified ruleset. The operation cannot be undone, so use with caution as it may affect event routing and incident management workflows. NOTE: Rulesets are deprecated as of January 2025. PagerDuty recommends migrating to Event Orchestration for new implementations. This endpoint remains available for managing existing rulesets but cannot be used to create new rulesets or rules. See PagerDuty's Event Orchestration migration guide for more information. Returns a 204 No Content status on successful deletion, or 404 if the ruleset or rule is not found.
Delete ruleset by idDeletes a specific ruleset from the PagerDuty system based on the provided ID. This endpoint should be used when you need to remove an existing ruleset, which may be necessary during incident management reconfiguration or when cleaning up obsolete rulesets. The deletion is permanent and cannot be undone, so use this endpoint with caution. It's important to note that deleting a ruleset will affect the incident routing and escalation policies associated with it, potentially impacting your organization's incident response workflow. PagerDuty no longer permits creating Rulesets/Event Rules, but this endpoint remains available for deleting an existing Ruleset. PagerDuty recommends migrating existing Rulesets to Event Orchestration.
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.
Delete schedule by idThe DeleteSchedule endpoint removes a specific schedule from the PagerDuty system. It is used to delete outdated or unnecessary on-call schedules, helping to maintain an organized and efficient incident management workflow. This operation is permanent and cannot be undone, so it should be used with caution. The endpoint is particularly useful when restructuring team rotations or when a project or team associated with the schedule is no longer active. It's important to note that deleting a schedule does not affect any historical data or past incidents associated with it, but it will prevent the schedule from being used in future incident assignments.
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.
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.
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.
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.
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.
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.
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.
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)
Delete team escalation policyThis endpoint removes an escalation policy association from a specific team in PagerDuty. It is used to update team configurations by disassociating an escalation policy that is no longer needed or relevant for the team's incident management process. The operation is irreversible and should be used with caution, as it may affect the team's incident response workflow. This endpoint is particularly useful when reorganizing team responsibilities or during cleanup of outdated escalation policies. It does not delete the escalation policy itself, but only removes its association with the specified team.
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.
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.
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.
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.
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.
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.
Delete all user sessionsDeletes all active sessions for a specified user in the PagerDuty system. This endpoint is used to forcibly log out a user from all devices and applications where they might be currently authenticated. It's particularly useful for security purposes, such as when a user's credentials may have been compromised, or when offboarding an employee. The operation is irreversible and will require the user to re-authenticate on all devices. Use with caution as it may disrupt the user's ongoing work if not coordinated properly.
Delete user session by typeThis endpoint deletes a specific user session in PagerDuty. It is used to forcibly terminate an active session for a given user, effectively logging them out from a particular device or application. This operation is crucial for maintaining security, especially when you need to revoke access immediately, such as when a device is lost or stolen, or when suspicious activity is detected. The endpoint requires the user ID, session type, and specific session ID to accurately target and remove the desired session. It should be used cautiously as it will immediately terminate the user's access without warning.
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.
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.write`
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).
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)
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.
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.
Fetch cache variable for event orchestrationRetrieves detailed information about a specific cache variable in a PagerDuty event orchestration. Cache variables store dynamic data from events (recent values, trigger counts, or external data) to enable complex routing and automation workflows. Returns: Variable ID, name, configuration (type and settings), conditions (PCL expressions), disabled status, and metadata (timestamps, user references). Use cases: Inspect configuration before updates, debug orchestration logic, audit settings, verify automation rules. Prerequisites: Event Intelligence/Digital Operations plan or AIOps add-on, event_orchestrations:read scope, Team Manager+ permissions. Note: Read-only. Use fetch_event_orchestrations to get orchestration IDs, get_event_orchestration_cache_variables to list all variables.
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.
Fetch escalation polices listRetrieves a list of escalation policies configured in the PagerDuty account. This endpoint allows users to access detailed information about how incidents are escalated within their organization, including the sequence of notifications and assignments for different teams or individuals. It's particularly useful for reviewing and auditing the incident response process, ensuring that critical alerts are properly routed and escalated. The endpoint provides a comprehensive view of all escalation policies, which is essential for maintaining an effective incident management strategy. However, it does not modify any existing policies or create new ones; it's purely for retrieval and review purposes.
Fetch event orchestrationsRetrieves a list of event orchestrations configured in the PagerDuty account. Event orchestrations are used to manage and automate the routing and handling of events and incidents. This endpoint allows you to fetch details about existing orchestrations, which can be useful for auditing, reporting, or managing your incident response workflows. The response typically includes information such as orchestration names, associated routing keys, and configured rules. Use this endpoint when you need to review or list the current event orchestrations in your PagerDuty setup. Note that this endpoint does not provide real-time event data or incident details, only the configuration of the orchestrations themselves.
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.
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.
Fetch outlier incident by idRetrieves detailed information about an outlier incident associated with a specific incident in PagerDuty. This endpoint is used to gather insights on incidents that deviate significantly from normal patterns, helping teams identify and analyze unusual or potentially critical issues. It should be used when investigating anomalies in incident patterns or when conducting post-incident reviews. The endpoint provides specific data about the outlier incident, which can be crucial for understanding unique characteristics or severity of the issue compared to typical incidents. **Note**: This feature requires the PagerDuty AIOps add-on. Services must have AIOps enabled to access outlier incident data. Without this add-on, requests will return a 403 Forbidden error.
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.
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.
Fetch related change events for incidentRetrieves change events correlated with a specific incident, along with the reasons for correlation. Change events represent service changes such as deploys, build completions, and configuration updates that may be related to the incident. Change correlation is based on three factors: - Time: Recent changes within 24 hours of the incident - Related service: Changes to services involved in the incident - Intelligence: Machine learning-based relevance scoring Use this action to: - Understand what recent changes might have caused an incident - Investigate incident root causes during triage - Compile comprehensive incident reports with change context - Audit system changes related to specific incidents IMPORTANT: This endpoint requires the PagerDuty AIOps add-on (Enterprise plan feature). Accounts without this add-on will receive a 403 Forbidden error.
Fetch related incidents by idRetrieves a list of incidents that are potentially related to a specified incident in PagerDuty. This endpoint utilizes machine learning algorithms to identify and return up to 20 recent incidents on other services that may be connected or similar to the given incident. It's particularly useful for incident management teams to gain a broader context of ongoing issues, identify patterns, and potentially streamline resolution processes. The endpoint should be used when investigating an incident to discover any correlated problems or when trying to understand the wider impact of a particular issue across the system. It does not modify any incident data and is intended for informational purposes only. **Note**: This feature requires the PagerDuty AIOps add-on. Services must have AIOps enabled to access related incident data. Without this add-on, requests will return a 404 Not Found error.
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.
Fetch status pagesRetrieves a list of all status pages configured in the PagerDuty account. Status pages provide real-time information about the operational status of services, ongoing incidents, and planned maintenance. This endpoint should be used when you need to obtain an overview of all available status pages, which can be useful for monitoring, reporting, or integrating status information into other systems. The response will include details such as the status page ID, name, and current state. Note that this endpoint does not provide the actual content of each status page, but rather metadata about the pages themselves.
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.
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.
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.
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.
Get a field option on a custom fieldRetrieves a specific field option from a custom field on an incident type. Field options represent the selectable values for multi-value or dropdown custom fields in PagerDuty. This action returns details about a single field option including its value, data type, and other metadata. **Prerequisites:** 1. A valid incident type ID or name (use PAGERDUTY_LIST_INCIDENT_TYPES) 2. A valid custom field ID for that incident type (use PAGERDUTY_LIST_INCIDENT_TYPE_CUSTOM_FIELDS) 3. A valid field option ID for that custom field (use PAGERDUTY_LIST_FIELD_OPTIONS_ON_A_CUSTOM_FIELD) **Note:** This is an Early Access endpoint requiring the `custom_fields.read` OAuth scope. The X-EARLY-ACCESS header with value 'analytics-v2' is automatically included.
Get aggregated pd advance usage dataProvides aggregated metrics for the usage of PD Advance. <!-- theme: info --> > **Note:** Analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule). It takes up to 24 hours before new incidents appear in the Analytics API. Scoped OAuth requires: `analytics.write`
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.
Get alerts by incident idRetrieves all alerts associated with a specific incident in PagerDuty. Alerts are the raw events that triggered or contributed to an incident. This endpoint allows users to fetch detailed information about these alerts, including their status, creation time, severity, and related service information. It is particularly useful for incident postmortems, auditing purposes, understanding alert grouping behavior, or investigating which monitoring events led to an incident. The endpoint returns a paginated list of alerts with optional filtering by status or alert_key, and supports including additional related data like services, first trigger log entries, or parent incident details.
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.
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.
Get analytics raw incidents responsesRetrieves raw response data from a single incident in PagerDuty. Use this when you need detailed information about who was asked to respond to a specific incident and their response status.
Get analytics raw usersGet raw user analytics data from PagerDuty. Use when you need detailed user activity and configuration metrics for analysis and reporting.
Get an incident typeGet detailed information about a single incident type. Accepts either an incident type id, or an incident type name. Incident Types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incident) Scoped OAuth requires: `incident_types.read`
Get an incident type custom fieldGet a custom field for an incident type. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. Scoped OAuth requires: `custom_fields.read`
Get incident workflow 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.
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.
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.
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.
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.
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.
Get business services impactsList Business Services sorted by impacted status. Returns all business services in the account, sorted with impacted services first, followed by non-impacted services.
Get business services priority thresholdsRetrieves the current priority threshold settings for all business services in PagerDuty. This endpoint allows users to fetch the configured thresholds that determine incident prioritization and escalation for each business service. It should be used when auditing or reviewing the current priority configurations across the organization's services. The tool provides a comprehensive view of how incidents are categorized and escalated based on their severity for different business services. It does not allow modification of these thresholds; for changes, a separate update endpoint would be required.
Get business service subscribers by idRetrieves a list of subscribers for a specific business service in PagerDuty. This endpoint allows you to fetch all users or teams configured to receive notifications for incidents related to the specified business service. It's useful for auditing who is responsible for responding to issues within a particular service, or for managing notification settings at a service level. The endpoint returns read-only data and does not modify any configurations. Use this when you need to review or verify the current subscriber list for a business service, such as during incident response planning or service ownership reviews.
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.
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.
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.
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.
Get event orchestration by idRetrieves detailed information about a specific event orchestration in PagerDuty using its unique identifier. This endpoint allows users to fetch the configuration and settings of a particular event orchestration, which is crucial for understanding and analyzing how incidents are being managed and automated within the PagerDuty system. It should be used when you need to review or audit the setup of an event orchestration, such as its routing rules, filters, and associated services. The endpoint provides a comprehensive view of the orchestration but does not modify any settings. Keep in mind that access to this information may be restricted based on the user's permissions within the PagerDuty account.
List cache variables for event orchestrationLists 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.
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.read`
Get event orchestration integrationRetrieves detailed information about a specific integration associated with an event orchestration in PagerDuty. This endpoint allows you to fetch the configuration and settings of a particular integration within the context of an event orchestration. Use this when you need to inspect or verify the setup of an integration, such as its type, configuration parameters, or connection status. The endpoint is particularly useful for troubleshooting integration issues or when you need to review the current state of an integration as part of your incident management workflow. Note that this endpoint only provides read access to the integration details and cannot be used to modify the integration.
Get extension schema by idRetrieves a specific extension schema from PagerDuty by its unique identifier. Extension schemas are pre-defined templates that define how PagerDuty integrates with external systems (like webhooks, Slack, Amazon EventBridge, ServiceNow, etc.). Each schema contains configuration details, supported webhook event types (trigger, acknowledge, resolve, etc.), UI elements (icons, logos), and metadata about the integration. This endpoint returns the complete definition of a specific extension schema including its label, description, required configuration fields, send types, features, and addon information. Use this action when you need to understand the capabilities and configuration requirements of a specific integration type before creating an extension instance. The schema ID can be obtained from the list extension schemas endpoint. This is a read-only operation that doesn't modify any data.
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.
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.
Get incident log entries by idRetrieves all log entries associated with a specific incident in PagerDuty. This endpoint provides a comprehensive history of actions, notifications, and status changes related to the incident. It should be used when detailed information about the lifecycle of an incident is needed, such as for post-incident reviews, auditing, or tracking the incident resolution process. The endpoint returns log entries in chronological order, allowing users to trace the incident's progression from creation to resolution. Note that the number of log entries returned may be large for long-running or complex incidents, so pagination might be necessary (though not specified in the given schema).
Get incident workflow action by idRetrieves detailed information about a specific incident workflow action by its ID. An incident workflow action is a reusable automation step that can be used in incident workflows. This endpoint returns the action's metadata including its name, description, inputs, outputs, and configuration details. Use this when you need to: - Inspect the configuration and parameters of a workflow action - Understand what inputs an action requires before using it in a workflow - View the outputs an action produces - Verify action metadata like version, domain, and package information The action ID follows the format: 'domain_name:package_name:function_name:version' (e.g., 'pagerduty.com:slack:send-message:1'). This is a read-only operation that does not modify or execute the action.
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.
Get incident workflows actionsRetrieves a list of all available actions that can be used in incident workflows within PagerDuty. This endpoint provides information about the various automated tasks and responses that can be configured to streamline incident management processes. It should be used when setting up or modifying incident workflows to understand the range of actions available for automation. The endpoint returns details about each action, which may include its name, description, and any configurable parameters. This tool is particularly useful for developers and system administrators who are designing or optimizing their incident response procedures in PagerDuty. Note that while this endpoint retrieves action information, it does not execute or modify any actions itself.
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.
Get log entriesRetrieves log entries from the PagerDuty system, providing a detailed history of events and actions related to incidents and system activities. This endpoint is crucial for auditing purposes, allowing users to track changes, responses, and other important events within their incident management workflow. It supports filtering by date range and specific incidents, making it useful for both broad overview analysis and detailed incident investigations. The endpoint uses pagination to manage large sets of log entries, ensuring efficient data retrieval and processing.
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.
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.
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.
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.
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.
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.
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).
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.
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.
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.
Get enablements for a serviceRetrieves 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.
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.
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.
Get specific post update statusRetrieves the updates for a specific post on a PagerDuty status page. This endpoint allows users to fetch the chronological list of updates made to a particular post, providing detailed information about how the status or information has changed over time. It's particularly useful for tracking the progression of an incident or maintenance event that has been communicated through a status page. The endpoint should be used when there's a need to review the history of updates for a specific status page post, such as during post-incident reviews or when compiling reports on communication effectiveness during incidents.
Get status dashboard by idRetrieves detailed information about a specific status dashboard in PagerDuty. Status Dashboards represent user-defined views for the Status Dashboard product that are limited to specific Business Services. This endpoint fetches the configuration, components, and current status of a particular dashboard. **IMPORTANT**: This is an early-access feature that requires: - The X-EARLY-ACCESS header set to 'status-dashboards' - Specific account permissions or subscription tier - The Status Dashboard feature enabled on your PagerDuty account Use this endpoint when you need to retrieve details about a known status dashboard by its ID. The endpoint is read-only and does not modify any data. To list all available status dashboards, use the retrieve_status_dashboards_information action first to obtain valid dashboard IDs.
Get status for status page by idRetrieves the current status of a specific item on a PagerDuty status page. This endpoint is used to fetch up-to-date information about the operational state of a particular service or component listed on a status page. It's particularly useful for integrations that need to monitor or display the latest status of services to users or internal systems. The endpoint requires both the status page ID and the specific status item ID, allowing for precise querying of individual service statuses within a larger status page context. This tool should be used when you need to programmatically check the current state of a specific service on a PagerDuty status page, such as during incident management or for creating custom dashboards.
Get status page impacts by idRetrieves the list of impact level configurations available for a specific status page in PagerDuty. Impact levels are predefined severity descriptors (such as 'Minor', 'Major', 'Critical', or 'All Good') that describe how business services are affected during incidents. This endpoint returns the configuration metadata for all impact levels on a status page, including their IDs, names, and descriptions. Use this action when you need to understand what impact levels are available for categorizing service disruptions on a status page, such as when creating status page posts or analyzing incident severity options. Optionally filter by post type (incident or maintenance) to see impacts relevant to specific post types. Note: This retrieves impact level metadata/configurations, not information about actual ongoing incidents or service disruptions.
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.
Get tags by entity typeRetrieves all entities of a specific type that are associated with a given tag. Use this when you need to find all users, teams, or escalation policies that have been tagged with a particular tag. The response will only include the entity type specified in the request (e.g., if entity_type is 'users', only the users array will be populated). This is useful for filtering and organizing resources by tags, or for auditing which resources are associated with specific categorization labels.
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.
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.
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.
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.
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](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `services.read`
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).
Get user session by typeRetrieves detailed information about a specific user session in PagerDuty. This endpoint allows you to fetch session-related data for a particular user, filtered by session type and identified by a unique session ID. It's useful for monitoring user activity, troubleshooting authentication issues, or auditing system access. The endpoint returns data about the specified session, which may include creation time, last activity timestamp, expiration time, and other relevant session attributes. It should be used when detailed information about a user's specific session is required, but it does not provide information about other sessions or general user account details.
Get user sessions by idRetrieves all active sessions for a specific user in PagerDuty. This endpoint allows you to fetch information about a user's current login sessions, which can be useful for auditing, security monitoring, or managing user access. It provides details such as session start times, device information, and IP addresses for each active session. Use this endpoint when you need to track user activity, investigate potential security issues, or manage concurrent logins. Note that this endpoint only returns information about active sessions and does not provide historical session data or the ability to modify sessions.
Get user status update notification rulesRetrieves all status update notification rules for a specific user in PagerDuty. Returns a list of all notification rules that determine how the user receives notifications about incident status updates. Each rule specifies a contact method (email, SMS, or phone) to be used for sending status update notifications. Common use cases: - View all configured status update notification rules for a user - Audit user notification preferences and contact methods - Check which contact methods are set up for status updates - Verify notification configuration before modifying rules The response includes the total count of rules and detailed information about each rule including the associated contact method (with email address or phone number when included).
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.
Get workflow integrationGet details about a Workflow Integration. Scoped OAuth requires: `workflow_integrations.read`
Get workflow integration connectionGet details about a Workflow Integration Connection. Scoped OAuth requires: `workflow_integrations:connections.read`
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.
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.
List all workflow integration connectionsList all Workflow Integration Connections. Scoped OAuth requires: `workflow_integrations:connections.read`
List automation action detailsThis endpoint retrieves a list of automation actions configured in the PagerDuty account. Automation actions are predefined tasks or operations that can be executed automatically in response to incidents or other triggers. The endpoint allows users to view all available automation actions, which can be useful for auditing, managing, or integrating these actions into other workflows. It supports pagination for handling large sets of actions and can include related information about associated services and teams. Use this endpoint when you need to review, inventory, or programmatically access the automation capabilities within your PagerDuty environment. Note that this endpoint only provides information about existing actions and does not create, modify, or execute the actions themselves.
List extension schemasRetrieves all available extension schemas from the PagerDuty API. This endpoint allows users to fetch custom schema extensions that have been defined for their PagerDuty account. Extension schemas are used to add custom data structures or validation rules to the standard API schema, enabling more flexible and tailored data management. This tool is particularly useful when you need to understand the custom data fields or structures that have been added to your PagerDuty implementation. It does not create, modify, or delete extension schemas; it only provides a read-only view of the existing schemas.
List field options on a custom fieldLists all field options for a custom field on an incident type. Field options represent the selectable values for multi-value or dropdown custom fields in PagerDuty. This action returns all available options that users can select when categorizing or tagging incidents with this custom field. **Prerequisites:** 1. A valid incident type ID or name (use PAGERDUTY_LIST_INCIDENT_TYPES) 2. A valid custom field ID for that incident type (use PAGERDUTY_LIST_INCIDENT_TYPE_CUSTOM_FIELDS) 3. The custom field should be of type 'multi_value' or 'multi_value_fixed' to support options **Note:** This is an Early Access endpoint requiring the `custom_fields.read` OAuth scope. The X-EARLY-ACCESS header with value 'analytics-v2' is automatically included.
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.
List incident type custom fieldsList the custom fields for an incident type. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. Scoped OAuth requires: `custom_fields.read`
List incident typesList the available incident types Incident Types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. These can be filtered by enabled or disabled types. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidentType) Scoped OAuth requires: `incident_types.read`
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.
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.
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.
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.
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.
List templatesRetrieves a list of templates available in the PagerDuty system. Templates are pre-defined configurations used for creating alerts, notifications, and other automated processes within PagerDuty. This endpoint should be used when you need to view or manage the existing templates in your PagerDuty account. It provides an overview of all templates, which can be useful for auditing, updating, or selecting templates for use in incident management workflows. The endpoint does not create, modify, or delete templates; it is solely for retrieving template information.
List workflow integration connectionsList all workflow integration connections for a specific workflow integration. Workflow integration connections represent configured instances of external tools (like AWS, Slack, HTTP APIs) that can be used in incident workflows. This action retrieves all connections associated with a particular integration type. Scoped OAuth requires: `workflow_integrations:connections.read`
List workflow integrationsList available Workflow Integrations. Scoped OAuth requires: `workflow_integrations.read`
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.
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.
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.
Modify entity tagsAdd and/or remove tags from a PagerDuty entity (user, team, or escalation policy) in a single operation. This action modifies the tags associated with a specific entity. You can: - Add tags by label (creates new tags if they don't exist) - Add tags by ID reference (links existing tags) - Remove tags by ID reference - Perform add and remove operations simultaneously Tags are useful for categorizing and organizing PagerDuty resources, enabling easier searching and filtering. Supported entity types: - users: Tag individual users - teams: Tag teams (requires Teams feature) - escalation_policies: Tag escalation policies Note: Creating new tags requires appropriate permissions.
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.
Post account subscription for business serviceThis endpoint creates or updates an account subscription for a specific business service in PagerDuty. It allows users to manage subscription settings, such as notification preferences or service-level agreements, for a particular business service identified by its unique ID. Use this endpoint when you need to set up new subscription configurations or modify existing ones for a business service. The endpoint is particularly useful for automating subscription management across multiple business services or integrating subscription updates with other systems. Note that this operation may affect billing or service access, so it should be used carefully and with proper authorization.
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.
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.
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.
Send change event to PagerDutySend 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.
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.
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").
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.
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.
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.
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.
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.
Post responder incidents with filtersRetrieves a list of incidents associated with a specific responder in the PagerDuty incident management system. This endpoint allows for detailed filtering and pagination of incident data, making it ideal for analyzing a responder's workload, performance, and incident trends over time. It supports various filter criteria such as creation time range, urgency, major incident status, team and service associations, and priority levels. The tool is particularly useful for generating reports, conducting operational reviews, and optimizing incident response processes. It should be used when detailed incident information for a specific responder is needed, but not for real-time incident updates or for modifying incident data.
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.
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.
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.
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.
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}.
Retrieve abilities listRetrieves a list of abilities or capabilities available in the PagerDuty system. This endpoint allows users to query and understand the features and functionalities they can access or perform within PagerDuty. It's particularly useful for determining the scope of actions available to the authenticated user or for checking the overall feature set of the PagerDuty instance. The endpoint should be used when you need to discover or verify the available abilities, such as during initial setup, permission audits, or when planning integrations. It does not modify any data and is safe to call frequently.
Test ability availability 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.
Retrieve action services by idRetrieves a list of services associated with a specific automation action in PagerDuty. This endpoint allows users to fetch all services that are linked to a particular automation action, providing insights into which components or systems are affected by the automated process. It's useful for auditing automation configurations, understanding the scope of automated actions, and managing incident response workflows. The endpoint should be used when you need to review or verify the services connected to an automation action, but it won't provide details about the action itself or modify any existing configurations.
Check if service event orchestration is activeCheck 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.
Retrieve addon by idRetrieves detailed information about a specific addon installed on a PagerDuty account. This endpoint allows users to fetch the current configuration, status, and other relevant details of an addon without modifying it. It's particularly useful for auditing installed addons, troubleshooting integration issues, or gathering information before making changes to an addon's setup. The endpoint returns a comprehensive view of the addon, which may include its type, version, configuration parameters, and current operational status. Use this endpoint when you need to inspect or verify the details of a particular addon in your PagerDuty environment.
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.
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.
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.
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'.
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.
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.
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.
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.
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.
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 systems
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.
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.
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.
Retrieve entity tags by idRetrieves the tags associated with a specific entity in the PagerDuty system. This endpoint allows you to fetch all tags that have been assigned to a particular resource. Supported entity types are users, teams, and escalation_policies. Tags are useful for categorization, filtering, and organizing entities within PagerDuty. The endpoint requires specifying both the entity type and its unique identifier to correctly locate the resource. This operation is read-only and does not modify any data. Supports pagination via limit and offset parameters.
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.
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.
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.
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.
Retrieve incident custom fieldsRetrieves a list of custom fields associated with incidents in PagerDuty. Custom fields are additional data points that can be added to incidents to provide more detailed information tailored to specific organizational needs. This endpoint allows you to fetch all defined custom fields, which can be useful for understanding the structure of incident data, preparing for incident creation or updates, or auditing the current custom field configuration. The response will include details such as field names, types, and any predefined options for each custom field. Use this endpoint when you need to review or work with the custom field definitions in your PagerDuty account, such as when integrating with other systems or preparing reports that involve custom incident data.
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.
Retrieve incident field optionsRetrieves the available field options for a specific custom incident field in PagerDuty. This action returns the predefined set of values that can be assigned to a multi-value or dropdown custom field. Field options are useful for: - Populating dropdown menus in incident forms - Validating user input against allowed values - Understanding possible values for categorizing incidents - Maintaining consistency in incident metadata **Prerequisites:** 1. A valid custom incident field ID (use PAGERDUTY_RETRIEVE_INCIDENT_CUSTOM_FIELDS) 2. The field should be of type 'multi_value' or 'multi_value_fixed' to have options **Note:** This endpoint requires the `incident_custom_fields:read` OAuth scope. Only fields with predefined options will return results; free-text fields have no options.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Retrieve rule by service idRetrieves a specific service event rule by ID from a PagerDuty service. Service Event Rules configure how incoming events are processed, including setting severity and priority based on conditions. **Important:** This accesses the legacy Service Event Rules system (EOL Jan 31, 2025). The GET API remains available for reading existing rules, but new rule creation is disabled. For new implementations, use Event Orchestration (PAGERDUTY_GET_THE_SERVICE_ORCHESTRATION_FOR_A_SERVICE). **Use Cases:** Audit existing rules, retrieve rule details before migrating to Event Orchestration, review historical settings, troubleshoot legacy workflows. **Note:** This retrieves a single rule. Use PAGERDUTY_RETRIEVE_RULES_FOR_SERVICE_ID to list all rules for a service.
Retrieve ruleset by idRetrieves detailed information about a specific ruleset in PagerDuty using its unique identifier. This endpoint allows you to fetch the complete configuration and settings of a single ruleset, which is essential for understanding how incident responses are automated and managed. Use this when you need to review, audit, or troubleshoot a particular ruleset's configuration. The response will include all relevant details such as the ruleset's name, type, routing keys, and associated rules. It's particularly useful when you need to examine the exact setup of a ruleset without making any changes. Note that this endpoint only provides read access and cannot be used to modify the ruleset.
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.
Retrieve rules for service idRetrieves all rules associated with a specific PagerDuty service. This endpoint allows users to fetch the set of rules that define when and how incidents are triggered for a particular service. It's essential for understanding the current automation and alert routing setup for a given service. Use this endpoint when you need to audit, review, or programmatically access the rule configurations for a service. The endpoint returns rule details but does not provide information about ongoing incidents or service status. It's particularly useful for integrations that need to sync or analyze rule configurations across multiple services or external systems.
Retrieve rules from ruleset by idRetrieves a list of event rules associated with a specific ruleset in PagerDuty. **Note**: Rulesets reached end-of-life on January 31, 2025 and are no longer visible in the PagerDuty web app. However, read-only API access is still available for existing rulesets. New rulesets cannot be created. PagerDuty recommends migrating to Event Orchestration for ongoing event routing configuration. This endpoint returns information about each rule in a ruleset, including: - Rule conditions that determine when the rule applies - Actions to execute when conditions are met - Rule ordering/position - Active/disabled status **Use Cases**: - Audit existing event routing configuration - Document legacy ruleset behavior before migration - Troubleshoot event routing issues with existing rulesets The response supports pagination for rulesets with many rules.
Retrieve schedule audit records by idRetrieves the audit records for a specific PagerDuty schedule. This endpoint allows you to access a comprehensive log of all changes made to the specified schedule, including modifications to on-call rotations, time periods, and associated team members. It's particularly useful for compliance purposes, tracking historical changes, and understanding how the schedule has evolved over time. The returned data typically includes details such as the timestamp of each change, the user who made the modification, and the specific alterations made to the schedule.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Retrieve standards scores by resource type and idRetrieves 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.
Retrieve standards scores by resourcetypeRetrieves the standards scores for a specified resource type in PagerDuty. This endpoint allows users to access performance metrics and evaluations based on predefined standards for different components of their incident management system. It's useful for assessing the effectiveness of various resources against established benchmarks, helping teams identify areas for improvement and maintain high-quality incident response processes. The endpoint should be used when seeking quantitative insights into the performance of specific PagerDuty resource types against industry or internal standards.
Retrieve status dashboard by slugRetrieves detailed information about a specific PagerDuty status dashboard using its URL slug. This endpoint allows users to fetch the current state, components, and other relevant data associated with a particular status dashboard. It's useful for integrating PagerDuty's status information into external monitoring systems or custom dashboards. The endpoint should be used when you need to programmatically access up-to-date information about a known status dashboard. Note that this endpoint only provides information for existing dashboards and does not create or modify dashboard data.
Retrieve status dashboards informationRetrieves a list of status dashboards and their associated information from the PagerDuty system. This endpoint provides a comprehensive overview of the current operational status, performance metrics, and health indicators across various systems or services monitored by PagerDuty. It's particularly useful for obtaining a high-level view of system status without diving into specific incidents or alerts. The endpoint should be used when you need to quickly assess the overall health of your monitored systems, identify any ongoing issues or incidents, and get a snapshot of key performance indicators. It's ideal for regular system checks, creating status pages, or integrating system health information into other monitoring tools. While this endpoint offers a broad view of system status, it may not provide detailed information about specific incidents or historical data. For in-depth analysis of particular issues or long-term trends, you may need to use other specialized endpoints.
Retrieve status page postRetrieves all posts associated with a specific status page in PagerDuty. This endpoint allows you to fetch updates, messages, and status information that have been posted to a particular status page. Use this to monitor the history of service status updates, incident communications, or maintenance notices for a given status page. The endpoint returns a list of posts with details including post content, title, type, timestamps, impacted services, severity, and status updates. You can filter results by post type (incident or maintenance), review status, or specific status IDs. This is a read-only endpoint and cannot be used to create, modify, or delete posts.
Retrieve status page severities by idRetrieves the list of severities associated with a specific status page in PagerDuty. This endpoint allows users to fetch the current severity levels configured for a particular status page, which is crucial for understanding the criticality of incidents or service statuses displayed on that page. It should be used when there's a need to programmatically access or display the severity information for a given status page, such as in monitoring dashboards or integrated incident management systems. The endpoint provides only the severity data and does not modify any existing configurations.
Retrieve status pages statusRetrieves the current statuses for a specified PagerDuty status page. This endpoint allows users to fetch real-time status information for a given status page, providing up-to-date details on service availability and any ongoing issues. It's particularly useful for monitoring the current state of services, especially during incident management processes. The endpoint should be used when there's a need to programmatically access the latest status information for a specific status page, enabling integration with other systems or dashboards for enhanced visibility of service health.
Retrieve status page subscription by idRetrieves a list of subscriptions associated with a specific PagerDuty status page. This endpoint allows users to fetch all current subscriptions for a given status page, enabling them to monitor who is receiving updates about the status page. It should be used when you need to review or audit the subscription list for a particular status page. The endpoint provides subscription details but does not allow for modification of subscriptions. Note that the response may be paginated for status pages with a large number of subscriptions.
Retrieve tag by idRetrieves detailed information about a specific tag in the PagerDuty system using its unique identifier. This endpoint allows users to fetch the properties and metadata associated with a particular tag, which can be useful for incident management, reporting, and organization within PagerDuty. It should be used when detailed information about a specific tag is needed, such as its name, description, or any custom attributes. The endpoint will not modify or create tags; it is purely for retrieval of existing tag data. Note that the response will only include information for tags that the authenticated user has permission to view.
Retrieve tagsRetrieves a list of tags from your PagerDuty account with optional filtering and pagination. Tags are used to categorize and label entities such as teams, users, and escalation policies in PagerDuty. This endpoint is useful when you need to browse available tags, search for specific tags by label, or build tag selection interfaces. Supports filtering by tag label using the 'query' parameter and pagination using 'limit' and 'offset' parameters. The response includes tag IDs, labels, and API URLs which can be used with other tag-related endpoints. Note: This endpoint returns tag definitions only, not information about which entities are tagged with them.
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.
Retrieve team details by idRetrieves detailed information about a specific team in PagerDuty based on the provided team ID. This endpoint allows users to fetch comprehensive data about a team, including its members, roles, and configurations. It is particularly useful for applications that need to display or process team information, such as team management dashboards or reporting tools. The endpoint returns all available details about the specified team, providing a snapshot of its current state within the PagerDuty system.
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.
Retrieve technical service detailsRetrieves detailed information about a specific technical service and its dependencies within the PagerDuty incident management platform. This endpoint is used to fetch comprehensive data about a single technical service, including its relationships with other services, its role in the overall service dependency structure, and any associated metadata. It's particularly useful for understanding the impact and connections of a specific service within an organization's technical infrastructure. The endpoint should be used when detailed information about a particular technical service's dependencies and relationships is needed, such as during incident analysis, service mapping, or system architecture reviews. It does not modify any data and is safe for frequent use in monitoring or dashboard applications.
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).
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.
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.
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.
Retrieve user contact methods via idRetrieves all contact methods associated with a specific user in PagerDuty. This endpoint allows you to fetch the various ways a user can be contacted during an incident, such as email addresses, phone numbers, or push notifications to mobile devices. It's particularly useful when you need to review or update a user's notification preferences or ensure that the correct contact information is on file. The endpoint returns a list of contact methods, likely including details such as the type of contact method, the specific address or number, and possibly the status (e.g., verified, primary). It should be used when setting up new users, auditing user information, or integrating PagerDuty with other communication systems. Note that this endpoint only provides read access to contact methods and cannot be used to add, modify, or remove contact information.
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.
Retrieve user notification ruleRetrieves a specific notification rule for a given user in PagerDuty. This endpoint allows you to fetch detailed information about how and when a particular user receives alerts and notifications. It's useful for auditing user preferences, troubleshooting notification issues, or when you need to review or potentially update a user's notification settings. The endpoint returns the configuration of the specified rule, including contact methods, time-based restrictions, and urgency levels. It should be used when you need to examine or verify the settings of a particular notification rule for a user, but it won't provide an overview of all rules or allow modifications to the rule.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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 incident
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.
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.
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.
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.
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.
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.
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.
Update a custom field for an incident typeUpdate a custom field for an incident type. Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. Scoped OAuth requires: `custom_fields.write`
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'.
Update alert grouping settings byidUpdate 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.
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.
Update an incident typeUpdate an Incident Type. Incident Types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incident) Scoped OAuth requires: `incident_types.write`
Update incident workflow triggerUpdates an existing incident workflow trigger in PagerDuty. Triggers define when and how incident workflows are activated - either automatically based on conditions, manually by responders, or for specific incident types. You can update the trigger type, workflow association, PCL conditions, service scope, and permissions. Conditional triggers require a PCL condition string (e.g., "incident.priority matches 'P1'"). Specify either a services list or subscribed_to_all_services (not both). Common use cases: - Change which workflow a trigger executes - Update the conditions for a conditional trigger - Modify service associations - Update permissions for manual triggers - Switch trigger type (e.g., from manual to conditional) Requires the `incident_workflows.write` OAuth scope.
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.
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.
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).
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 scope
Update custom field optionUpdates a field option for a custom field on an incident type in PagerDuty. Field options represent the selectable values for multi-value or dropdown custom fields. Use this action to modify the display value or data type of an existing option. **Prerequisites:** 1. A valid incident type ID or name (use PAGERDUTY_LIST_INCIDENT_TYPES) 2. A valid custom field ID for that incident type (use PAGERDUTY_LIST_INCIDENT_TYPE_CUSTOM_FIELDS) 3. An existing field option ID to update (use PAGERDUTY_LIST_FIELD_OPTIONS_ON_A_CUSTOM_FIELD) 4. The custom field should be of type 'multi_value' or 'multi_value_fixed' to support options **Common use cases:** - Renaming field options to match updated terminology (e.g., "Critical" → "Urgent") - Correcting typos in existing field option values - Adjusting options to better reflect current operational needs **Note:** This is an Early Access endpoint requiring the `custom_fields.write` OAuth scope. The X-EARLY-ACCESS header with value 'analytics-v2' is automatically included.
Update escalation policy by idUpdates an existing escalation policy in PagerDuty with new settings and rules. This endpoint allows you to modify various aspects of an escalation policy, including its name, description, escalation rules, associated services, and team. It's used when you need to change how incidents are escalated and handled within your organization. The updated policy details are provided in the request body, and the policy to be updated is identified by its ID in the URL path. This tool is essential for maintaining and adjusting incident response workflows in PagerDuty to ensure optimal team responsiveness and incident management.
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).
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.
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.
Update event rule by idThis endpoint allows you to update an existing Event Rule within a specified Ruleset in PagerDuty. Event Rules define conditions for matching events and actions to take when those conditions are met. You can modify various aspects of the rule, including its active status, matching conditions, time frames, variables, position in the ruleset, and associated actions. This endpoint is particularly useful for fine-tuning your incident management workflow, adjusting how events are processed, and controlling alert behavior. It's important to note that changes made through this endpoint will immediately affect how incoming events are handled, so careful consideration should be given to the potential impact on your alerting system. PagerDuty no longer permits creating Rulesets/Event Rules, but this endpoint remains available for modifying an existing Ruleset Event Rule. PagerDuty recommends migrating existing Event Rules to Event Orchestration.
Update event rule for serviceThis endpoint allows you to update an existing Event Rule for a specific service in PagerDuty. Event Rules are used to define how incoming events should be processed, including conditions for matching events and actions to take when a match occurs. You can modify various aspects of the rule, such as its conditions, time-based restrictions, variables for extraction, and actions to perform on matching events. This endpoint is particularly useful for fine-tuning event management processes, adjusting rule priorities, or temporarily disabling rules without removing them entirely. It provides granular control over event handling, allowing for sophisticated automation and incident management workflows. PagerDuty no longer permits creating Rulesets/Event Rules, but this endpoint remains available for modifying an existing Service Event Rule. PagerDuty recommends migrating existing Event Rules to Event Orchestration.
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.
Update the global orchestration for an event 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](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`
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.
Update incident by idThe UpdateIncident endpoint allows you to modify various attributes of an existing incident in PagerDuty's incident management system. This PUT operation enables users to update incident status, priority, assignments, escalation levels, and other key properties. It's particularly useful for reflecting the current state of an incident, reassigning responsibilities, or adjusting the incident's urgency and escalation path. The endpoint should be used when there are significant changes to an incident that need to be reflected in the system, such as acknowledging the incident, marking it as resolved, or changing its priority. It's important to note that this endpoint updates an existing incident and does not create new incidents. Care should be taken when modifying critical fields like status or escalation policy, as these changes can significantly impact the incident management workflow.
Update incident custom field valuesUpdates custom field values for a specific incident in PagerDuty. Custom fields enrich incidents with metadata like environment, severity, version info, runbook links, etc. Supports string, number, boolean, URL, datetime, and select field types. Operation is idempotent and overwrites existing values for specified fields. Requires incident:write scope and pre-configured custom fields (typically on Enterprise plans). Use PAGERDUTY_RETRIEVE_INCIDENT_CUSTOM_FIELDS to get available field IDs before updating.
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.
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.
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.
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.
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.
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.
Update oncall handoff notification ruleThis endpoint updates an existing on-call handoff notification rule for a specific user in PagerDuty. It allows you to modify the notification delay, handoff type, and contact method for the rule. Use this endpoint when you need to change how and when a user is notified about upcoming on-call shifts or when they are going off-call. The endpoint requires both the user ID and the specific rule ID in the URL path. You can update the notification delay (in minutes), the type of handoff (both, oncall, or offcall), and the preferred contact method for the notification. This endpoint is particularly useful for adjusting notification preferences as team structures or individual availability changes.
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.
Update ruleset by idUpdates an existing ruleset in the PagerDuty incident management system. This endpoint allows you to modify the name of a ruleset or change its team association. It's used when you need to adjust the configuration of a specific ruleset, such as renaming it for better clarity or reassigning it to a different team. The endpoint requires the ruleset's unique ID and accepts updates to the name and team fields. It's important to note that other fields like routing keys, creation details, and update history are read-only and cannot be modified through this call. This endpoint is particularly useful for maintaining and organizing rulesets as your incident management needs evolve. PagerDuty no longer permits creating Rulesets/Event Rules, but this endpoint remains available for modifying an existing Ruleset. PagerDuty recommends migrating existing Rulesets to Event Orchestration.
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.
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.
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.write
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.
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.
Update status page post infoCreates or updates a post update on a specific PagerDuty status page. This endpoint allows you to add new information or modify existing updates related to an incident or maintenance event. Use this when you need to communicate changes in status, provide additional details, or update the severity of an ongoing situation. The post update can include a custom message, current status, severity level, and list of impacted services. You can also control whether subscribers should be notified and optionally schedule future updates. This tool is essential for maintaining clear and timely communication with stakeholders during incidents or planned maintenance periods. Note that this endpoint does not create new status page posts; it only adds updates to existing posts.
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.
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.
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.
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.write`
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.
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.
Update user status update 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.
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.
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`
