Pagerduty

The 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Updates a specific status update notification rule for a pagerduty user. this endpoint allows you to modify how a user receives notifications about incident status changes. it’s used to change the contact method (e.g., email, phone, push notification, or sms) for a particular notification rule. this is useful for adjusting user preferences or updating contact information. the endpoint requires the user’s id and the specific notification rule id in the url path, ensuring precise updates to the intended rule.

Action Parameters

Action Response

Retrieves a list of incidents that are potentially related to a specified incident in pagerduty. this endpoint utilizes machine learning algorithms to identify and return incidents 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.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Creates a new template in pagerduty for standardized status updates. this endpoint allows users to define customizable templates for various notification types, including emails and short messages. it’s primarily used to streamline communication during incident management by providing consistent and pre-formatted status update messages. the template can include placeholders for dynamic content, allowing for personalized and context-specific notifications. this endpoint should be used when setting up new standardized communication formats for incident updates, but it’s important to note that currently only ‘status update’ type templates are supported.

Action Parameters

Action Response

Updates 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’.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves the available field options for a specific custom field associated with incidents in pagerduty. this endpoint allows users to fetch the predefined set of values that can be assigned to a particular custom field, enabling efficient incident management and customization. use this endpoint when you need to populate dropdowns, validate input, or understand the possible values for a custom field in your incident management workflow. it’s particularly useful for maintaining consistency in incident data and facilitating automated processes that interact with custom fields.

Action Parameters

Action Response

Creates a new response play in pagerduty, which is a predefined set of actions to be executed in response to an incident. this endpoint allows you to configure automated responses, including adding subscribers, assigning responders, setting up conference details, and defining how the response play can be triggered. use this when you want to standardize and automate your incident management process, ensuring consistent and efficient responses to different types of incidents. the response play can be set to run automatically for specific services or be manually triggered by team members or responders, depending on the configuration. this tool is particularly useful for creating templated responses for common incident types or for implementing best practices across your organization’s incident management workflow.

Action Parameters

Action Response

Creates a new integration within an existing event orchestration in pagerduty. this endpoint allows users to set up connections between pagerduty and external systems or services, enabling automated event management and incident response. it should be used when adding a new integration to an event orchestration, such as connecting a monitoring tool or alerting system. the endpoint requires minimal information, focusing on the integration’s label for identification purposes. note that this endpoint only creates the integration; additional configuration may be required in the pagerduty interface or through other api calls to fully set up the integration’s functionality.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

The 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.

Action Parameters

Action Response

Retrieves the impacts of a specific incident on business services within pagerduty. this endpoint allows users to assess the scope and severity of an ongoing incident by providing detailed information about which business services are affected and to what extent. it should be used when there’s a need to understand the broader implications of an incident across the organization’s critical operations. the tool is particularly useful for incident managers, stakeholders, and support teams who need to prioritize response efforts based on the impact severity. note that this endpoint only provides impact data for a single incident at a time and does not offer historical or aggregate impact information across multiple incidents.

Action Parameters

Action Response

The 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

The 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Deletes 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.

Action Parameters

Action Response

Create new incident workflow trigger scoped oauth requires: incident workflows.write

Action Parameters

Action Response

Creates 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.

Action Parameters

Action Response

Create a new workflow integration connection. scoped oauth requires: workflow integrations:connections.write

Action Parameters

Action Response

Retrieves detailed information about a specific status dashboard in pagerduty. this endpoint allows users to fetch the current configuration, components, and status of a particular dashboard, which is crucial for monitoring system health and managing incidents efficiently. it should be used when you need to access up-to-date information about a known status dashboard, such as during incident response or when updating dashboard configurations. the endpoint will not modify any data and is intended for read-only operations.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Retrieves a list of impactors currently affecting business services in pagerduty. impactors are entities or events that have the potential to negatively impact the performance, availability, or functionality of one or more business services. this endpoint is essential for proactive incident management, risk assessment, and maintaining service reliability. use this endpoint to get a comprehensive view of potential threats to your business services, allowing you to prioritize your response and allocate resources effectively. the returned data can be used to identify patterns, anticipate cascading failures, and improve overall system resilience. while this endpoint provides valuable information about current impactors, it does not offer historical data or predictive analysis. it should be used in conjunction with other monitoring and analysis tools for a complete understanding of your service health and potential risks.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves a specific extension schema from pagerduty by its unique identifier. this endpoint is used to fetch detailed information about a custom data structure that extends the functionality of the pagerduty api. it’s particularly useful for developers who need to understand or work with custom fields or data structures in their pagerduty integrations. the endpoint returns the complete definition of the requested extension schema, including any custom fields, their types, and other metadata. this tool should be used when you need to inspect or verify the structure of a specific extension schema, but it won’t allow you to modify the schema or create new ones. keep in mind that access to extension schemas may be subject to account permissions and the schema must exist in the pagerduty account for the request to succeed.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Creates a new team within your pagerduty account. this endpoint allows you to establish a group of users with shared responsibilities, often used for organizing incident management and on-call schedules. use this when setting up a new department, project team, or any other group that needs to collaborate on incident responses. the created team can be configured as public or private, determining the level of access for non-members. note that while you can create the team structure with this call, you’ll need separate api calls to add members or assign schedules to the team.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Deletes 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Creates 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.

Action Parameters

Action Response

This endpoint updates an existing escalation policy for a specific team in pagerduty. it modifies incident escalation rules within the team context, crucial for maintaining up-to-date response workflows. use this when changes to the team’s escalation process are needed, such as adjusting notification rules or modifying escalation steps. note that it only updates the team-policy association, not the global policy configuration.

Action Parameters

Action Response

Creates 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.

Action Parameters

Action Response

List 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. > ### 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

Action Parameters

Action Response

The 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.

Action Parameters

Action Response

Update an existing workflow integration connection. scoped oauth requires: workflow integrations:connections.write

Action Parameters

Action Response

Update the global orchestration for an event orchestration. global orchestration rules allows you to create a set of event rules. these rules evaluate against all events sent to an event orchestration. when a matching rule is found, it can modify and enhance the event and can route the event to another set of global rules within this orchestration for further processing. for more information see the api concepts document scoped oauth requires: event orchestrations.write

Action Parameters

Action Response

This endpoint creates a new integration for a specific pagerduty service. it allows you to set up various types of integrations, including email-based and events api v2 integrations. the primary use case is to establish new channels for incident creation and management within a pagerduty service. this tool is particularly useful when setting up automated alerting systems or connecting external monitoring tools to pagerduty. the integration type and configuration options determine how incidents are triggered and processed. note that this endpoint focuses on creation only and does not handle updating or deleting existing integrations.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves a list of all extensions associated with the authenticated pagerduty account. extensions are additional features or integrations that enhance pagerduty’s functionality, such as custom notification methods or third-party service connections. this endpoint is useful for auditing the extensions currently in use, planning integration strategies, or managing the account’s extension ecosystem. it provides a comprehensive overview of all extensions without the need for specific query parameters. however, it does not allow for filtering or sorting of the results, so all data processing must be done client-side.

Action Parameters

Action Response

This endpoint allows you to update an existing alert grouping setting in pagerduty. alert grouping settings define how alerts are automatically grouped into incidents, helping to streamline incident management and reduce noise. you can modify various aspects of the grouping configuration, including the grouping type (content-based or intelligent), time window, and the fields used for grouping. this tool is particularly useful when you need to refine your alert grouping strategy to improve incident response efficiency. note that some features, such as intelligent grouping, may only be available on certain pagerduty plans. when using this endpoint, ensure that you provide all required fields in the request body, as partial updates are not supported.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Create 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. > ### 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

Action Parameters

Action Response

Retrieves a list of incident workflows configured in the pagerduty account. this endpoint allows users to fetch information about automated sequences of actions set up to respond to incidents. it’s useful for reviewing existing workflows, auditing incident response processes, or gathering data for reporting purposes. the endpoint supports pagination and filtering by workflow name. it does not create, modify, or delete workflows; it’s purely for retrieval of workflow information.

Action Parameters

Action Response

Get a service orchestration. a service orchestration allows you to create a set of event rules. the service orchestration evaluates events sent to this service against each of its rules, beginning with the rules in the “start” set. when a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this service orchestration for further processing. for more information see the api concepts document scoped oauth requires: services.read

Action Parameters

Action Response

Delete a field option for a custom field. > ### 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

Action Parameters

Action Response

Retrieves detailed information about a specific action within an incident workflow in pagerduty. this endpoint allows users to fetch the configuration, settings, and other relevant details of a particular workflow action by providing its unique identifier. it is useful for inspecting the current state of an action, troubleshooting workflow issues, or gathering information for reporting purposes. the endpoint should be used when you need to examine or verify the properties of an individual workflow action, but it does not modify or execute the action itself.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Create 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. > ### 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 scoped oauth requires: incident types.write

Action Parameters

Action Response

Deletes 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.

Action Parameters

Action Response

Updates 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.

Action Parameters

Action Response

This endpoint allows you to modify the tags associated with a specific entity in pagerduty. it provides functionality to both add new tags and remove existing ones in a single api call. the endpoint is particularly useful for updating the categorization or labeling of pagerduty entities such as incidents, services, or users. it supports adding tags by label (creating new ones if necessary) or by reference, and removing tags by their unique identifiers. this flexibility allows for efficient tag management across your pagerduty resources, enabling better organization and easier searching of entities. use this endpoint when you need to update the tags for a specific entity, either to refine its categorization or to align it with current operational needs.

Action Parameters

Action Response

Deletes a specific rule from a ruleset in pagerduty’s incident management platform. this endpoint allows users to remove individual event rules, providing flexibility in managing and updating rulesets. it should be used when you need to eliminate an outdated, unnecessary, or incorrect rule from a ruleset. the operation is permanent and cannot be undone, so caution should be exercised when using this endpoint. it’s important to note that deleting a rule may affect the event routing and actions defined in the ruleset, potentially impacting incident management workflows.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Updates 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

This endpoint retrieves analytics metrics for responder teams based on incident data in pagerduty. it allows for detailed filtering and customization of the data set, enabling users to analyze team and responder performance across various dimensions such as time range, urgency, priorities, and specific teams or responders. the endpoint is particularly useful for generating reports, assessing team efficiency, and identifying trends in incident management. it should be used when comprehensive analytics on responder team performance are needed, especially for large-scale or complex incident management scenarios. however, it’s important to note that the endpoint has a maximum time range of one year for analysis, and the results are limited to the data the requestor has access to within the pagerduty system.

Action Parameters

Action Response

Sets 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.

Action Parameters

Action Response

Retrieves a list of services associated with a specific status page in pagerduty. this endpoint is used to fetch detailed information about the services that are being monitored and displayed on a particular status page. it’s particularly useful when you need to review or update the services shown on a status page, or when integrating status page information with other systems. the endpoint returns service details such as names, current statuses, and any relevant metadata, allowing for comprehensive monitoring and management of services within the context of a status page.

Action Parameters

Action Response

Adds 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Creates a new post on a specified pagerduty status page. this endpoint allows you to publish information about incidents or scheduled maintenance, including details such as the post type, timing, and associated updates. use this to communicate service status, planned downtime, or ongoing issues to your users or customers. the post can include multiple updates, each with its own message, severity, and impact on specific services. this is particularly useful for providing real-time information during incidents or for scheduling and describing maintenance windows.

Action Parameters

Action Response

The updatewebhooksubscription endpoint allows you to modify an existing webhook subscription in pagerduty. this put method enables users to update the events they want to be notified about, change the filter criteria for triggering notifications, update the subscription’s description, and toggle its active state. it’s particularly useful for adjusting notification preferences as your incident management needs evolve. the endpoint requires specifying the webhook subscription id in the url path and accepts a json body with the updated subscription details. note that while you can update multiple aspects of the subscription, you must provide at least the ‘events’ array in your request. be cautious when updating filters, as this can significantly change which incidents trigger notifications.

Action Parameters

Action Response

Merges 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.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Creates 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Updates an existing post update on a pagerduty status page. this endpoint allows you to modify the details of a specific post update, including its message, status, severity, impacted services, and notification settings. use this when you need to provide new information about an ongoing incident, change the status or severity of an issue, or update the list of affected services. it’s particularly useful for keeping your audience informed about the progress of incident resolution or service status changes. the endpoint requires a comprehensive ‘post update’ object that encapsulates all the update details, ensuring that all necessary information is provided in a structured manner.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Deletes 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves the impacts associated with a specific status page in pagerduty. this endpoint allows users to fetch detailed information about service disruptions, incidents, or other events affecting the services displayed on a particular status page. it is useful for monitoring the current state of services, understanding the severity and scope of ongoing issues, and keeping stakeholders informed about service health. the endpoint should be used when there’s a need to programmatically access impact data for a status page, such as for integration with other monitoring tools or for creating custom dashboards.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Retrieves a list of past incidents related to a specific incident in pagerduty. this endpoint allows users to explore the historical context of an incident by fetching previous occurrences or related issues. it’s particularly useful for identifying recurring problems, analyzing incident patterns, and improving overall incident management processes. the endpoint should be used when investigating the root cause of an incident or when compiling reports on incident history. note that this endpoint focuses on historical data and does not provide real-time incident information or updates to the current incident status.

Action Parameters

Action Response

Creates 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.

Action Parameters

Action Response

Retrieves the active event orchestration configuration for a specific pagerduty service. this endpoint allows you to fetch the current rules and settings that determine how incidents are created and routed for the specified service. use this when you need to review or audit the active event handling setup for a particular service. it’s particularly useful for understanding how incoming events are being processed and managed within your pagerduty environment. this endpoint focuses solely on the active configuration and does not provide historical data or allow modifications to the orchestration rules.

Action Parameters

Action Response

List all workflow integration connections for a specific workflow integration. scoped oauth requires: workflow integrations:connections.read

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Executes a predefined response play for a specific incident in pagerduty. this endpoint allows you to trigger a sequence of automated actions designed to manage and respond to the given incident. it’s useful for standardizing and streamlining your incident response process, ensuring consistent handling of similar incidents. the endpoint requires you to specify the incident for which the response play should be run, using the incident’s unique identifier. note that the response play itself is identified by the id in the url path, not in the request body.

Action Parameters

Action Response

Retrieves the list of overrides for a specific schedule in pagerduty. this endpoint allows users to fetch temporary modifications to the regular on-call rotation, providing insight into any manual adjustments made to the schedule. it’s particularly useful for auditing changes, understanding the current state of a schedule, or verifying that overrides have been correctly applied. the endpoint should be used when there’s a need to review or analyze schedule modifications, especially in cases of incident management or when planning future on-call rotations. note that this endpoint only provides information about existing overrides and does not allow for creating, modifying, or deleting overrides.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves detailed information about a specific business service in pagerduty using its unique identifier. this endpoint allows users to fetch the current configuration, settings, and metadata associated with a particular business service. it should be used when detailed information about a single business service is needed, such as during service audits, configuration reviews, or when updating service information. the endpoint provides a comprehensive view of the service but does not include real-time incident data or historical performance metrics. it’s particularly useful for integrations that need to sync or display business service information in external systems.

Action Parameters

Action Response

Retrieves information about how a specific automation action is associated with a particular service in pagerduty. this endpoint allows users to query the relationship between an automation action and a service, providing details on how the action is configured or applied within the context of the specified service. it’s useful for understanding the automation setup for incident management and response processes for a given service. the endpoint requires both the automation action id and the service id to fetch the relevant association details.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Get the status of all oauth delegations revocation requests for this account, specifically how many requests are still pending. this endpoint is limited to account owners and admins. scoped oauth requires: oauth delegations.read

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Creates 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.

Action Parameters

Action Response

Retrieves a list of automation action runners associated with the pagerduty account. this endpoint allows users to view all available runners that can execute automation actions within their incident management workflow. it provides essential information about each runner, such as its id, name, and current status. use this endpoint when you need to manage, monitor, or select runners for executing automation actions. the response typically includes details that help in understanding the capacity and availability of runners for performing automated tasks. this endpoint is particularly useful for administrators and devops teams who need to oversee and optimize their automation infrastructure within pagerduty.

Action Parameters

Action Response

Removes 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.

Action Parameters

Action Response

Deletes 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.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves detailed information about a specific ability (feature capability) associated with a pagerduty account using its unique identifier. this endpoint allows users to query the system for the status and details of a particular feature, such as ‘teams’ or ‘incident management’, to determine if it’s available and potentially get additional configuration information. it’s particularly useful when you need to verify the presence of a specific functionality or gather more details about a feature’s implementation in your account. the endpoint should not be used to modify abilities or retrieve information about multiple abilities simultaneously.

Action Parameters

Action Response

Deletes 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.

Action Parameters

Action Response

Activates 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.

Action Parameters

Action Response

This endpoint disassociates service dependencies in pagerduty by deleting specified relationships between supporting and dependent services. it allows for the removal of multiple service dependencies in a single api call, enabling efficient management of service hierarchies and relationships within the pagerduty platform. the endpoint should be used when restructuring service dependencies, removing obsolete relationships, or updating the service topology. it’s important to note that this operation is irreversible and will immediately affect the dependency structure of the services involved.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves all posts associated with a specific status page in pagerduty. this endpoint allows users to fetch updates, messages, and status information that have been posted to a particular status page. it’s useful for monitoring the history of service status updates, incident communications, or maintenance notices for a given status page. the endpoint returns a list of posts, likely including details such as post content, timestamp, and author information. it should be used when you need to review or display the communication history related to service statuses or incidents tracked on a specific pagerduty status page. note that this endpoint only provides read access to existing posts and cannot be used to create, modify, or delete posts.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Update a field option for a custom field. > ### 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

Action Parameters

Action Response

Updates 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.

Action Parameters

Action Response

Updates or creates a postmortem for a specific post on a pagerduty status page. this endpoint allows users to add detailed analysis and insights about an incident after its resolution. it’s primarily used for communicating the cause, impact, and lessons learned from an incident to stakeholders and subscribers. the postmortem can include rich text content for comprehensive explanations. users can control whether subscribers are notified about the postmortem update, making it flexible for both major updates and minor edits. this endpoint is crucial for maintaining transparency and improving incident management processes.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves the current alert grouping settings for the pagerduty account. this endpoint provides information on how alerts are automatically grouped together in the incident management system. it should be used when you need to understand or audit the current configuration for alert grouping, which can impact how incidents are organized and presented to responders. the endpoint returns the global settings that apply across the account, but it does not provide information about service-specific alert grouping rules or real-time grouping status of active incidents. this information is crucial for administrators managing large-scale incident response processes or when troubleshooting alert noise issues.

Action Parameters

Action Response

The 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.

Action Parameters

Action Response

Delete a workflow integration connection. scoped oauth requires: workflow integrations:connections.write

Action Parameters

Action Response

Updates 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.

Action Parameters

Action Response

Provides aggregated metrics for the usage of pd advance. > note: analytics data is updated periodically. it takes up to 24 hours before new incidents appear in the analytics api. scoped oauth requires: analytics.read

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Analyzes 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.

Action Parameters

Action Response

Retrieves a list of change events from the pagerduty system within a specified time range. change events represent notifications or updates that occur within a pagerduty account, such as modifications to teams, services, or escalation policies. this endpoint is useful for monitoring and auditing changes in the pagerduty configuration, helping to track system modifications and ensure compliance with change management processes. the response typically includes details about each change event, such as the type of change, affected resources, timestamp, and the user who initiated the change. use this endpoint when you need to review recent changes, investigate system modifications, or generate reports on configuration updates within your pagerduty account.

Action Parameters

Action Response

Delete all oauth delegations as per provided query parameters. 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. at this time, this endpoint only supports deleting mobile app oauth delegations for a given user. this is equivalent to signing users out of the mobile app. this is an asynchronous api, the deletion request itself will be processed within 24 hours. scoped oauth requires: oauth delegations.write

Action Parameters

Action Response

Retrieves detailed information about a specific team associated with an automation actions runner in pagerduty. this endpoint is used to get insights into the relationship between a runner and a particular team, which is crucial for understanding access permissions and management of automation tasks. it should be used when you need to confirm team associations, verify permissions, or gather team-specific details related to a runner. the endpoint does not modify any data and is primarily for information retrieval purposes. note that this endpoint focuses on a single team-runner relationship and does not provide a comprehensive list of all teams associated with a runner or vice versa.

Action Parameters

Action Response

Creates 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.

Action Parameters

Action Response

This endpoint adds a service to an existing incident workflow trigger in pagerduty. it allows you to associate a specific service with a trigger, enabling automated incident management processes for that service. use this endpoint when you need to connect a service to an incident workflow, typically during the setup or modification of your incident response procedures. the endpoint requires the trigger’s id and the service’s id to make the association. it’s important to note that this operation doesn’t create new services or triggers, but rather links existing ones. ensure that both the trigger and service exist in your pagerduty account before making this call.

Action Parameters

Action Response

Deletes 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.

Action Parameters

Action Response

Retrieves a list of unrouted events for a specific event orchestration in pagerduty. this endpoint is used to identify and review events that have not yet been assigned or processed within the designated event orchestration workflow. it’s particularly useful for monitoring the efficiency of your incident management process and ensuring that no critical events are left unattended. the endpoint should be used when you need to audit your event handling, identify potential bottlenecks in your orchestration setup, or manually intervene with unprocessed events. note that this endpoint only provides information about unrouted events and does not allow for direct manipulation of these events.

Action Parameters

Action Response

Retrieves all alerts associated with a specific incident in pagerduty. this endpoint allows users to fetch detailed information about the notifications and alerts that were triggered as part of an incident’s lifecycle. it is particularly useful for incident postmortems, auditing purposes, or understanding the notification flow during an incident. the endpoint returns a list of alerts, which may include information such as alert creation time, alert status, and the targets (users or services) that received the notifications. it should be used when detailed alert information for a known incident is required, but it will not provide information about the incident itself beyond its associated alerts.

Action Parameters

Action Response

List field options for a custom field. 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. > ### 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

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Unsubscribes 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.

Action Parameters

Action Response

Retrieves the available fields for pagerduty templates. this endpoint provides a comprehensive list of all possible fields that can be used when creating or modifying templates within the pagerduty platform. it is particularly useful for developers and administrators who need to understand the structure and available options for template customization. the endpoint should be used when building interfaces for template management, automating template creation, or gathering information about the configurable aspects of pagerduty templates. it does not modify any existing templates or create new ones; it only provides information about the available fields.

Action Parameters

Action Response

Creates 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Deletes 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.

Action Parameters

Action Response

This endpoint allows you to send responder requests for a specific incident in pagerduty. it is used to request additional help or notify specific users or escalation policies about an ongoing incident that requires attention. the endpoint creates a new responder request associated with the incident identified by the {id} path parameter. it’s particularly useful when you need to quickly engage additional resources or escalate an incident to ensure timely resolution. this tool should be used when there’s a need to bring in more responders or escalate an incident beyond its current assigned team. it’s important to note that this endpoint doesn’t resolve the incident itself but facilitates the process of engaging additional help.

Action Parameters

Action Response

Retrieves a list of change events related to a specific incident in pagerduty. this endpoint is used to gather contextual information about changes or updates associated with an incident, which can be crucial for understanding its progression and resolution. it provides insights into actions taken, system modifications, or other relevant events that occurred in connection with the incident. use this endpoint when investigating incident timelines, auditing response actions, or compiling comprehensive incident reports. note that this endpoint only returns change events directly linked to the specified incident and does not provide general incident details or unrelated events.

Action Parameters

Action Response

Retrieves a list of all tags currently used within the pagerduty account. this endpoint provides a comprehensive view of the tags used for categorization and labeling of incidents across the system. it should be used when you need an overview of all available tags for incident management, reporting, or when setting up new incident routing rules. the endpoint returns all tags without any filtering, which may result in a large dataset for accounts with extensive tag usage. it does not provide information about which incidents or entities are associated with each tag.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

This endpoint removes a specific service from a trigger within an incident workflow in pagerduty. it is used to modify the configuration of an existing incident workflow by disassociating a service from a particular trigger. this action is useful when you need to update the automation rules or remove a service from the automated response process for certain incidents. the endpoint requires both the trigger id and the service id to be specified in the url path. upon successful execution, the specified service will no longer be associated with the trigger, affecting future incident workflow executions. this operation cannot be undone, so it should be used with caution to avoid disrupting critical incident management processes.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Updates the channel information for a specific log entry in pagerduty. this endpoint allows you to modify the details of how notifications are delivered for a particular log entry, while maintaining the original channel type. it’s useful for refining or correcting the notification settings of an existing log entry. the endpoint requires the log entry id in the url path and accepts a json payload with updated channel information. note that while you can update the channel details, you cannot change the channel type, which must match the existing value.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Converts the rules associated with a specific pagerduty service to a new or optimized format. this endpoint is used to update and standardize the incident management rules for a given service, improving the efficiency and consistency of alert handling. it should be used when there’s a need to modernize rule sets, apply best practices, or adapt rules to changing service requirements. the conversion process is applied to all rules linked to the specified service id, potentially modifying their structure or behavior. it’s important to note that this operation may impact existing incident routing and alerting patterns, so it should be used cautiously and preferably during a maintenance window.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Creates 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.

Action Parameters

Action Response

Creates a new event rule for a specific service in pagerduty. this endpoint allows you to define complex conditions and actions for handling incoming events, enabling automated incident management and alert routing. use this when you need to set up custom logic for processing events, such as setting priorities, annotating incidents, or suppressing alerts based on specific criteria. the rule’s position in the evaluation order can be specified, and various time-based conditions can be applied to control when the rule is active. this endpoint is crucial for fine-tuning your incident response workflow and reducing alert noise.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

This 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.

Action Parameters

Action Response

Retrieves 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.

Action Parameters

Action Response

Delete 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. > ### 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

Action Parameters

Action Response

Updates an existing response play in pagerduty’s incident management system. this endpoint allows you to modify various aspects of a response play, including its name, description, associated team, subscribers, responders, runnability, and conference details. use this when you need to alter the behavior or configuration of an existing response play to better suit your incident response processes. the update is performed by specifying the response play’s unique identifier and providing the updated information in the request body. this endpoint is particularly useful for refining your incident management automation based on evolving team structures, communication preferences, or response strategies.

Action Parameters

Action Response

Renders 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}.

Action Parameters

Action Response

Retrieves 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.

Action Parameters