Pagerduty

Deletes a specific custom field from incidents in pagerduty. this endpoint allows users to remove a custom field that is no longer needed or relevant for incident management. it should be used when you want to permanently delete a custom field from all incidents, both existing and future. the operation is irreversible, so caution should be exercised when using this endpoint. it’s important to note that this action will remove the specified custom field and its associated data from all incidents, which could impact reporting and analysis based on that field.

Action Parameters

Action Response

Retrieves a specific rule associated with a particular service in pagerduty. this endpoint allows you to access detailed information about a single rule, including its configuration and conditions, within the context of a specific service. it is useful for reviewing, auditing, or troubleshooting notification workflows. the endpoint should be used when you need to examine the settings of a particular rule for a given service, but it will not modify or create new rules. note that this endpoint only provides information for a single rule and does not return a list of all rules for the service.

Action Parameters

Action Response

This endpoint updates a cache variable associated with a specific service in pagerduty’s event orchestrations. it allows you to modify the cache variable’s name, configuration, conditions, and disabled state. use this endpoint when you need to change how a cache variable behaves, such as updating its value extraction method or trigger event count settings. the endpoint is particularly useful for fine-tuning event processing rules and maintaining dynamic incident management workflows. note that some fields like id, creation date, and last update information are read-only and cannot be modified through this endpoint.

Action Parameters

Action Response

Retrieves detailed information about a specific severity level on a particular status page in pagerduty. this endpoint is used to fetch the configuration and metadata associated with a severity, which is crucial for understanding how incidents are categorized and communicated on a status page. it provides insights into how different levels of service disruptions are represented and managed within the pagerduty system. this tool is essential for developers and administrators who need to programmatically access or audit severity configurations on status pages, enabling them to ensure consistent incident communication across their organization.

Action Parameters

Action Response

Retrieves the tags associated with a specific entity in pagerduty. this endpoint allows you to fetch all tags linked to a particular resource, such as an incident, service, user, team, or escalation policy. it’s useful for understanding how resources are categorized and organized within your pagerduty account. the endpoint should be used when you need to review or analyze the tagging structure of a specific entity, which can aid in incident management, reporting, and integration with other systems. note that this endpoint only retrieves existing tags and does not modify them; separate endpoints are required for tag management operations.

Action Parameters

Action Response

Deletes a specific notification rule for a user in pagerduty. this endpoint allows administrators or users with appropriate permissions to remove custom notification rules, modifying how and when a user receives alerts about incidents. it should be used when updating a user’s notification preferences or when a specific notification rule is no longer needed. the deletion is permanent and cannot be undone, so caution should be exercised when using this endpoint. it’s important to note that this action does not affect the user’s default notification rules or their overall ability to receive notifications; it only removes the specified custom rule.

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

Retrieves the current set of standards defined in the pagerduty account. standards in pagerduty refer to the policies and best practices for incident response and alerting. this endpoint allows users to fetch the configured standards, which may include response time goals, escalation policies, and other operational guidelines. it’s particularly useful for administrators and team leads who need to review or audit the current incident management standards across their organization. the endpoint does not allow for modification of standards; it’s strictly for retrieval purposes. users should note that the response may include all standards across the account, which could be extensive for large organizations.

Action Parameters

Action Response

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

Action Parameters

Action Response

Updates a specific field option for a custom field in pagerduty’s incident management system. this endpoint allows you to modify the value of an existing field option, providing flexibility in managing and customizing incident fields. it’s particularly useful when you need to rename or adjust the available options for a custom field in response to changing operational needs or terminology updates. the endpoint ensures that only mutable properties are updated while preserving system-managed attributes like creation timestamps. use this when you need to refine or correct the options available for incident classification or categorization within your pagerduty workflow.

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

Deletes a specific response play from the pagerduty system. this endpoint should be used when you need to remove an outdated or unnecessary response play from your incident management workflow. it permanently eliminates the predefined sequence of actions associated with the specified response play id. use this endpoint with caution, as the deletion is irreversible and may impact automated incident response processes. this operation is particularly useful for maintaining an up-to-date and efficient set of response strategies in your pagerduty account.

Action Parameters

Action Response

Creates a new custom field for incidents in pagerduty. this endpoint allows you to define additional data points to be associated with incidents, enhancing incident management and reporting capabilities. custom fields can be used to store various types of information such as environment, severity, or any other relevant metadata. the field can be configured with different data types and value constraints, allowing for flexible and structured data capture. use this endpoint when you need to extend the incident data model with organization-specific information. note that once created, certain properties of a custom field cannot be changed, so careful planning of field structure is important.

Action Parameters

Action Response

This endpoint deletes a specific user session in pagerduty. it is used to forcibly terminate an active session for a given user, effectively logging them out from a particular device or application. this operation is crucial for maintaining security, especially when you need to revoke access immediately, such as when a device is lost or stolen, or when suspicious activity is detected. the endpoint requires the user id, session type, and specific session id to accurately target and remove the desired session. it should be used cautiously as it will immediately terminate the user’s access without warning.

Action Parameters

Action Response

Deletes a specific extension from the pagerduty service. this endpoint should be used when you want to remove an additional feature or integration that has been previously added to your pagerduty account. it’s particularly useful for cleaning up obsolete integrations or disabling unwanted functionalities. note that deleting an extension is permanent and cannot be undone, so use this endpoint with caution. this operation doesn’t affect the core pagerduty service, only the specified extension.

Action Parameters

Action Response

Creates a new on-call schedule in pagerduty, defining rotation patterns for team members. this endpoint allows you to set up complex schedules with multiple layers, each having its own rotation pattern, user assignments, and time restrictions. use it to establish new on-call rotations, manage team availability, and ensure continuous incident response coverage. the created schedule can be used in escalation policies to determine who gets notified during incidents. note that while you can create a basic schedule structure, some elements like rendered schedule entries are read-only and will be populated by the system after creation.

Action Parameters

Action Response

Deletes a specific team from the pagerduty system based on the provided team id. this endpoint should be used when you need to remove a team that is no longer required in your incident management structure. it’s important to note that deleting a team is a permanent action and cannot be undone. before deletion, ensure that all associated users, schedules, and escalation policies have been properly reassigned or removed to prevent disruption to your incident management workflows. this operation does not delete the users within the team; it only removes the team structure itself.

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

This endpoint allows you to update an existing event rule for a specific service in pagerduty. event rules are used to define how incoming events should be processed, including conditions for matching events and actions to take when a match occurs. you can modify various aspects of the rule, such as its conditions, time-based restrictions, variables for extraction, and actions to perform on matching events. this endpoint is particularly useful for fine-tuning event management processes, adjusting rule priorities, or temporarily disabling rules without removing them entirely. it provides granular control over event handling, allowing for sophisticated automation and incident management workflows.

Action Parameters

Action Response

Retrieves detailed information about a specific event orchestration in pagerduty using its unique identifier. this endpoint allows users to fetch the configuration and settings of a particular event orchestration, which is crucial for understanding and analyzing how incidents are being managed and automated within the pagerduty system. it should be used when you need to review or audit the setup of an event orchestration, such as its routing rules, filters, and associated services. the endpoint provides a comprehensive view of the orchestration but does not modify any settings. keep in mind that access to this information may be restricted based on the user’s permissions within the pagerduty account.

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 a specific status update notification rule for a given user in pagerduty. this endpoint allows you to fetch detailed information about how and when a particular user receives notifications for status updates on incidents. it’s useful for auditing notification settings, troubleshooting notification issues, or programmatically managing user preferences. the endpoint should be used when you need to review or verify the configuration of a single notification rule for a specific user. it does not modify any settings and is read-only in nature.

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 audit records for a specific escalation policy in pagerduty. this endpoint allows users to access a detailed history of changes made to the escalation policy, including modifications to escalation rules, associated services, and on-call schedules. it’s particularly useful for compliance tracking, troubleshooting, and understanding how the incident response process has been adjusted over time. the audit records provide transparency into who made changes, what was changed, and when the changes occurred, helping teams maintain accountability and optimize their incident management workflows.

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 cache variable within a specific event orchestration in pagerduty. cache variables are used to store and manipulate dynamic data extracted from events, enabling complex event routing and automation. you can modify the cache variable’s name, configuration, conditions, and disabled state. the endpoint is particularly useful when you need to adjust how event data is processed or stored within your incident management workflows. it’s important to note that this operation will overwrite the existing cache variable properties, so you should include all desired fields in your update request, not just the ones you want to change.

Action Parameters

Action Response

Get details about a workflow integration. scoped oauth requires: workflow integrations.read

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 allows for bulk updating of multiple pagerduty incidents in a single api call. it can be used to modify various attributes of incidents such as status, priority, assignments, and more. this is particularly useful for automating incident management processes, batch resolving or acknowledging incidents, or updating incident details en masse. the endpoint accepts an array of incident objects, each containing the necessary updates, allowing for efficient management of multiple incidents simultaneously. it’s important to note that while many fields are optional, each incident object must include the ‘id’ and ‘type’ fields for proper identification and processing.

Action Parameters

Action Response

This endpoint allows you to update an existing team’s information in pagerduty. it is used to modify team properties such as name, description, and access permissions (public/private). the endpoint should be used when you need to change team details or adjust team visibility within the organization. it’s important to note that this endpoint can only modify mutable fields; read-only properties like ‘id’, ‘summary’, ‘self’, and ‘html url’ cannot be changed. when updating a team, ensure you provide all required fields, even if they haven’t changed, to avoid unintended modifications to the team structure.

Action Parameters

Action Response

Retrieves detailed information about a specific contact method for a particular user in pagerduty. this endpoint allows you to fetch the configuration and settings of a single contact method, such as an email address, phone number, or push notification settings, associated with a user’s account. it’s useful for verifying or auditing user contact information, or when you need to display or update a specific contact method. the endpoint requires both the user id and the contact method id to pinpoint the exact resource. it does not modify any data and is safe for frequent calls, but should be used judiciously in high-volume scenarios to avoid hitting rate limits.

Action Parameters

Action Response

Retrieves the notification subscriptions for a specific user in pagerduty. this endpoint allows you to fetch detailed information about how a user is configured to receive various types of notifications, such as incident alerts, updates, or system messages. it’s useful for auditing a user’s notification settings, troubleshooting communication issues, or when you need to review or modify a user’s notification preferences programmatically. the response likely includes a list of subscription objects, each detailing the type of notification, delivery method (e.g., email, sms), and any specific rules or filters applied. this endpoint should be used when you need to understand or manage a user’s notification setup within pagerduty.

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

Deletes a specific business service from the pagerduty system. this endpoint should be used when you want to permanently remove a business service that is no longer needed or relevant to your organization’s incident management structure. it’s important to note that this action is irreversible and will remove all associations between the deleted business service and any technical services or incidents. use this endpoint with caution, as it may impact reporting and historical data related to the deleted business service. before deletion, ensure that no active incidents or dependencies rely on this business service to avoid disruptions in your incident management workflow.

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

This endpoint removes a specific team’s access to an automation action in pagerduty. it’s used to revoke permissions when a team no longer needs to use or should not have access to a particular automation action. this operation is permanent and cannot be undone through this endpoint. it should be used carefully, as it will immediately prevent the specified team from executing the automation action. this endpoint is particularly useful for managing access control and ensuring that only authorized teams can perform certain automated tasks.

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

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

Deletes a specific tag from the pagerduty system based on its unique identifier. this endpoint should be used when you need to remove a tag that is no longer relevant or necessary for categorizing incidents, services, or other resources in pagerduty. it’s important to note that deleting a tag will remove it from all associated resources, which could impact filtering and organization within the pagerduty platform. this operation is irreversible, so it should be used with caution. the endpoint does not return the deleted tag’s information, so if you need to reference the tag details, you should retrieve them before deletion.

Action Parameters

Action Response

Deletes a specific subscription associated with a pagerduty status page. this endpoint is used to remove a subscription, effectively stopping notifications or updates related to the status page for the subscribed entity. it should be used when a user or system no longer needs to receive alerts or information about a particular status page. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint requires both the status page id and the specific subscription id to ensure precise removal of the intended subscription.

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

Retrieves the updates for a specific post on a pagerduty status page. this endpoint allows users to fetch the chronological list of updates made to a particular post, providing detailed information about how the status or information has changed over time. it’s particularly useful for tracking the progression of an incident or maintenance event that has been communicated through a status page. the endpoint should be used when there’s a need to review the history of updates for a specific status page post, such as during post-incident reviews or when compiling reports on communication effectiveness during incidents.

Action Parameters

Action Response

Retrieves the router configuration for a specific event orchestration in pagerduty. this endpoint allows you to fetch detailed information about how incidents and events are routed within a particular event orchestration setup. use this endpoint when you need to understand or audit the current routing logic for an event orchestration, such as determining which teams or escalation policies are assigned to handle specific types of incidents. the returned data will include routing rules, conditions, and associated actions, but will not modify any existing configurations. this endpoint is particularly useful for incident response planning and optimization of event management workflows.

Action Parameters

Action Response

The deleteschedule endpoint removes a specific schedule from the pagerduty system. it is used to delete outdated or unnecessary on-call schedules, helping to maintain an organized and efficient incident management workflow. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint is particularly useful when restructuring team rotations or when a project or team associated with the schedule is no longer active. it’s important to note that deleting a schedule does not affect any historical data or past incidents associated with it, but it will prevent the schedule from being used in future incident assignments.

Action Parameters

Action Response

This endpoint updates the label (name) of an integration associated with a specific event orchestration in pagerduty. it allows users to rename integrations for better organization and clarity within their incident management workflow. the endpoint should be used when there’s a need to change how an integration is identified within the pagerduty system, such as after a service rename or to improve naming conventions. it’s important to note that this endpoint only updates the label of the integration and does not modify any other properties or configurations of the integration or event orchestration.

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

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

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

This endpoint allows you to update the status of multiple alerts associated with a specific incident in pagerduty. it is particularly useful for bulk operations when you need to resolve or update the status of several alerts simultaneously within the context of a single incident. the endpoint accepts an array of alert objects, each containing the necessary information for the update. it’s important to note that this endpoint modifies existing alerts and cannot be used to create new alerts or incidents. use this when you need to efficiently manage and update the state of multiple alerts tied to an ongoing incident.

Action Parameters

Action Response

Deletes a specific contact method associated with a user in pagerduty. this endpoint should be used when you need to remove an outdated or unnecessary contact method from a user’s profile. it permanently removes the specified contact method, so use with caution. this operation cannot be undone. ensure that the user has at least one remaining contact method after deletion to maintain their ability to receive notifications. this endpoint is particularly useful for maintaining up-to-date user profiles and streamlining communication channels.

Action Parameters

Action Response

Deletes all priority thresholds for business services in the pagerduty account. this endpoint is used to remove the configured priority settings that determine how incidents are escalated based on their urgency for business services. it should be used when you want to reset or remove all priority threshold configurations across your business services. this operation is irreversible and will affect how future incidents are prioritized and escalated for all business services in the account. it’s important to note that this action does not delete the business services themselves, only their associated priority thresholds.

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

Creates one or more overrides for a specific schedule in pagerduty. this endpoint allows you to temporarily modify the on-call schedule by assigning different users for specific time periods. it’s useful for handling planned absences, shift swaps, or special coverage requirements without permanently altering the regular schedule. the overrides are applied to the schedule identified by the {id} parameter in the endpoint url. multiple overrides can be created in a single request, enabling efficient batch modifications to the schedule. each override specifies a start time, end time, and the user who will be on call during that period. the endpoint should be used when temporary changes to the on-call rotation are needed. it does not modify the underlying schedule configuration.

Action Parameters

Action Response

Creates a new automation runner in the pagerduty incident management system. this endpoint allows you to set up either a sidecar runner, which polls for invocations externally, or a runbook runner, which communicates directly with a runbook instance. use this when you need to automate actions within pagerduty, such as incident response processes or scheduled tasks. the runner can be associated with specific teams for better organization and access control. note that the required parameters differ based on the chosen runner type, with runbook runners requiring additional configuration for server connection.

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

Retrieves a list of all members associated with a specific team in pagerduty. this endpoint is useful for obtaining detailed information about the composition of a team, including user ids, names, roles, and contact information of team members. it should be used when you need to review or audit team membership, update on-call rotations, or gather information for reporting purposes. the endpoint does not modify team membership; it only provides read access to the current team roster. keep in mind that the response may be paginated for teams with a large number of members.

Action Parameters

Action Response

Creates a new webhook subscription in pagerduty to receive specific event notifications. this endpoint allows users to set up automated notifications for various incident-related events, such as triggers, acknowledgments, and resolutions. the webhook can be configured to filter events by service, team, or account-wide, and supports custom http headers for enhanced integration capabilities. use this when you need to integrate pagerduty’s real-time incident updates with external systems or workflows. note that the webhook’s secret for payload verification is only provided in the initial creation response and cannot be retrieved later.

Action Parameters

Action Response

Retrieves detailed information about a specific automation action invocation in pagerduty. this endpoint allows you to fetch the current state, results, and metadata of a previously executed automation action. it’s particularly useful for tracking the progress of long-running automations, auditing past actions, or troubleshooting failed invocations. the endpoint should be used when you need to review the outcome of a specific automation run or gather data for reporting purposes. note that this endpoint only provides information about the invocation itself and does not allow modification of the automation action or re-running of the invocation.

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 pingwebhooksubscription endpoint sends a test post request to a specified webhook subscription in your pagerduty account. this tool is used to verify that a webhook subscription is correctly configured and can receive notifications. it’s particularly useful after setting up a new webhook subscription or when troubleshooting integration issues. the endpoint doesn’t modify any data but simulates a real webhook delivery, allowing you to confirm that your systems can properly receive and process pagerduty webhooks. note that this tool only tests the delivery mechanism and doesn’t validate the processing of specific event types on your end.

Action Parameters

Action Response

Creates or updates a postmortem for a specific status page post in pagerduty. this endpoint allows you to add detailed analysis and insights about an incident after its resolution. the postmortem can include rich-text content and offers the option to notify subscribers. use this when you need to provide a comprehensive review of an incident, its root causes, and lessons learned. it’s particularly useful for maintaining transparency and improving incident response processes. note that the postmortem is limited to 10,000 characters and is always associated with an existing status page post.

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

Retrieves a list of maintenance windows from the pagerduty incident management platform. maintenance windows are scheduled periods during which alerts and notifications for specified services are suppressed to allow for system maintenance or updates without triggering unnecessary incidents. this endpoint should be used to get an overview of all maintenance windows, their schedules, and affected services. it supports filtering by team, service, and search query, as well as pagination for handling large result sets. the endpoint is particularly useful for reviewing upcoming maintenance schedules, auditing past maintenance windows, or integrating maintenance information into external systems or dashboards.

Action Parameters

Action Response

Retrieves a list of all webhook subscriptions associated with the authenticated pagerduty account. this endpoint allows users to view and manage their existing webhook configurations, which are used to receive real-time notifications about incidents, alerts, and other pagerduty events. it’s particularly useful for auditing current integrations, troubleshooting notification issues, or preparing to update webhook settings. the response likely includes details such as webhook urls, event types they’re subscribed to, and their current status. this endpoint should be used when you need an overview of all active webhook integrations but won’t provide the actual event data sent to these webhooks.

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

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

Retrieves detailed information about a specific template in pagerduty by its unique identifier. this endpoint is used to access the configuration and settings of a pre-defined template, which can include incident response procedures, notification rules, and other standardized actions. it’s particularly useful when you need to review or reference an existing template for incident management purposes. the endpoint returns comprehensive data about the template, but does not modify or create new templates.

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

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

This endpoint allows you to update an existing status page post on a specific pagerduty status page. it is used to modify the details of a post, such as its title, type (incident or maintenance), and timing information. the endpoint is particularly useful for updating the status of ongoing incidents or adjusting the details of planned maintenance activities. when using this endpoint, ensure that all required fields are provided, including the post type, title, and associated status page information. note that the starts at and ends at fields are only applicable and required for maintenance-type posts; for incident posts, these should be set to null.

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

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

Update an existing incident workflow trigger scoped oauth requires: incident workflows.write

Action Parameters

Action Response

Retrieves notifications from the pagerduty system. this endpoint allows users to fetch information about alerts, incidents, and other important notifications generated within the pagerduty platform. it’s particularly useful for monitoring recent activity, tracking incident updates, or integrating pagerduty notifications into other systems. the endpoint likely supports filtering and sorting options to help users narrow down the results to relevant notifications. however, it’s important to note that real-time notifications might not be immediately available through this endpoint, and there could be a slight delay between an event occurring and its notification being accessible via this api call.

Action Parameters

Action Response

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

Creates a new event orchestration in pagerduty, which defines how incoming events are processed and routed to appropriate services. this endpoint allows you to set up a configuration that manages the flow of events from various integrations, ensuring efficient incident handling. use this when you need to establish a new set of rules for event routing, especially when introducing new services or reorganizing your incident management workflow. the created orchestration can later be associated with specific integrations using their routing keys. note that while you can create the orchestration structure, the actual integrations and routing details are managed separately and will be populated as read-only information once configured.

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

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 updates custom field values for a specific incident in pagerduty. it allows you to modify or add custom fields to provide additional context or information about the incident. the endpoint is particularly useful when you need to update incident metadata dynamically, such as changing the environment, priority, or any other custom attributes associated with the incident. it supports various data types for field values, including boolean, numeric, string, array, date-time, and uri formats, providing flexibility in storing different types of information. this operation is idempotent, meaning repeated identical requests will not create additional changes beyond the initial request. however, be cautious when updating fields, as this will overwrite existing values for the specified fields.

Action Parameters

Action Response

Updates an existing service in pagerduty with the provided configuration. this endpoint allows you to modify various aspects of a service, such as its name, description, escalation policy, incident urgency rules, and alert grouping settings. use this when you need to change the behavior or properties of an existing service. the endpoint requires the service id and accepts a ‘service’ object containing the updated configuration. note that some properties (like ‘id’ and ‘created at’) are read-only and cannot be modified. certain advanced features, such as alert grouping and auto-pause notifications, may only be available on specific pagerduty plans.

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

Retrieves the tags associated with a specific entity in the pagerduty system. this endpoint allows you to fetch all tags that have been assigned to a particular resource, such as a user, team, service, or incident. it’s useful for categorization, filtering, and organizing entities within pagerduty. the endpoint requires specifying both the entity type and its unique identifier to correctly locate the resource. this operation is read-only and does not modify any data.

Action Parameters

Action Response

Update 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 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

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

Deletes the account subscription associated with a specific business service in pagerduty. this endpoint is used to terminate the subscription or billing relationship between a business service and the account. it should be used when you need to discontinue the subscription for a particular business service, such as when the service is no longer needed or when restructuring your pagerduty setup. this action is irreversible, so it should be used with caution. the endpoint does not return any specific data upon successful deletion, likely providing only a success status code.

Action Parameters

Action Response

This endpoint deletes a specific cache variable associated with a service in pagerduty’s event orchestration system. it is used to remove temporary data that is no longer needed, helping to maintain system efficiency. the endpoint should be used when you want to permanently remove a cache variable from a particular service, such as when the variable is obsolete or to free up resources. it’s important to note that this action is irreversible, and once deleted, the cache variable cannot be recovered. use this endpoint with caution to avoid accidentally removing critical data used in event orchestrations.

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

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

Retrieves the standards scores for a specified resource type in pagerduty. this endpoint allows users to access performance metrics and evaluations based on predefined standards for different components of their incident management system. it’s useful for assessing the effectiveness of various resources against established benchmarks, helping teams identify areas for improvement and maintain high-quality incident response processes. the endpoint should be used when seeking quantitative insights into the performance of specific pagerduty resource types against industry or internal standards.

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

Deletes all active sessions for a specified user in the pagerduty system. this endpoint is used to forcibly log out a user from all devices and applications where they might be currently authenticated. it’s particularly useful for security purposes, such as when a user’s credentials may have been compromised, or when offboarding an employee. the operation is irreversible and will require the user to re-authenticate on all devices. use with caution as it may disrupt the user’s ongoing work if not coordinated properly.

Action Parameters

Action Response

Retrieves and aggregates metrics for incidents across all services in pagerduty. this endpoint allows for extensive filtering and customization of incident data, enabling detailed analysis of operational performance. it’s particularly useful for generating reports, identifying trends, and assessing incident management efficiency over specified time periods. the endpoint supports various filtering criteria, time zone adjustments, and aggregation options, making it a powerful tool for both high-level overviews and granular incident analytics. however, users should be aware of the complexity of the filtering options and ensure they provide accurate parameters to obtain relevant data.

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

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

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

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

Retrieve an existing incident workflows trigger scoped oauth requires: incident workflows.read

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

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

Retrieves a specific notification rule for a given user in pagerduty. this endpoint allows you to fetch detailed information about how and when a particular user receives alerts and notifications. it’s useful for auditing user preferences, troubleshooting notification issues, or when you need to review or potentially update a user’s notification settings. the endpoint returns the configuration of the specified rule, including contact methods, time-based restrictions, and urgency levels. it should be used when you need to examine or verify the settings of a particular notification rule for a user, but it won’t provide an overview of all rules or allow modifications to the rule.

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

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

This endpoint allows you to snooze a specific incident in pagerduty for a defined duration. it temporarily pauses alerts and notifications for the incident, after which it automatically returns to an active state. use this when you need to temporarily suppress notifications for an incident that’s being worked on or requires a planned delay in response. the snooze action is particularly useful for managing alert fatigue, handling false positives, or delaying responses during maintenance windows. note that snoozing an incident does not resolve it; it simply delays further notifications until the snooze period ends or is manually cleared.

Action Parameters

Action Response

Retrieves the current license allocations for the pagerduty account. this endpoint provides an overview of how licenses are distributed across users, teams, or other entities within the organization. it should be used when you need to audit license usage, plan for license renewals, or manage resource allocation within your pagerduty account. the response likely includes details such as the total number of licenses, allocated licenses, and possibly information about which users or teams are using the licenses. this endpoint does not modify any license allocations; it is for informational purposes only. keep in mind that the response may be paginated for accounts with a large number of license allocations.

Action Parameters

Action Response

Creates a new status update notification rule for a specific user in pagerduty. this endpoint allows you to define how a user will be notified about incident status updates. it’s used to customize notification preferences for individual users, ensuring they receive timely updates through their preferred contact method. the rule specifies which contact method (email, phone, push notification, or sms) should be used for sending status updates. this is particularly useful for tailoring notification strategies to match users’ roles and responsibilities within the incident management process.

Action Parameters

Action Response

This endpoint removes an escalation policy association from a specific team in pagerduty. it is used to update team configurations by disassociating an escalation policy that is no longer needed or relevant for the team’s incident management process. the operation is irreversible and should be used with caution, as it may affect the team’s incident response workflow. this endpoint is particularly useful when reorganizing team responsibilities or during cleanup of outdated escalation policies. it does not delete the escalation policy itself, but only removes its association with the specified team.

Action Parameters

Action Response

Retrieves all active sessions for a specific user in pagerduty. this endpoint allows you to fetch information about a user’s current login sessions, which can be useful for auditing, security monitoring, or managing user access. it provides details such as session start times, device information, and ip addresses for each active session. use this endpoint when you need to track user activity, investigate potential security issues, or manage concurrent logins. note that this endpoint only returns information about active sessions and does not provide historical session data or the ability to modify sessions.

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

Retrieves detailed information about a specific post on a pagerduty status page. this endpoint allows you to fetch the content, timestamp, and any associated metadata for a particular update or message that has been posted to a status page. it’s particularly useful for retrieving historical updates about incidents, maintenance notices, or general service status communications. use this endpoint when you need to access or display the full details of a specific status update, such as when building a custom status page interface or integrating pagerduty status updates into another system. note that this endpoint only retrieves information for existing posts; it cannot be used to create, modify, or delete posts.

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 the cache variables associated with a specific event orchestration in pagerduty. this endpoint allows you to access temporary data storage elements used during event orchestration processes, which are crucial for maintaining context and improving efficiency in incident management workflows. use this endpoint when you need to inspect or debug the current state of an event orchestration’s cache variables, or when you want to retrieve stored information for further processing in your incident management pipeline. note that cache variables are temporary and may not persist indefinitely, so the retrieved data represents the current state at the time of the api call.

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

Creates notification subscriptions for a specific team in pagerduty. this endpoint allows you to subscribe a team to receive notifications for one or more incidents or business services. use this when you want to ensure a team is notified about specific critical events or the status of important business services. the endpoint requires a list of subscribable entities, each identified by a unique id and type. it’s particularly useful for setting up or updating a team’s notification preferences in bulk. note that this endpoint only creates new subscriptions and doesn’t affect existing ones.

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

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

The analyzeincidentmetrics endpoint aggregates and analyzes incident data for pagerduty services based on specified filters and parameters. it allows users to generate detailed reports and insights on incident management performance across various dimensions such as time, urgency, teams, and services. this endpoint is particularly useful for operational reviews, trend analysis, and performance monitoring of incident response processes. the tool provides flexible filtering options to focus on specific subsets of incidents and supports various time-based aggregations for comprehensive analysis. it’s important to note that while the endpoint offers extensive customization, it has a maximum supported time range of one year between the start and end dates for incident creation.

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 response plays configured in the pagerduty account. response plays are predefined sets of actions that can be automatically executed when an incident occurs, helping to streamline and standardize incident response processes. this endpoint allows you to fetch and review existing response plays, which is useful for auditing, reporting, or integrating response play information into other systems. the list can be paginated and filtered using various parameters to manage large sets of response plays efficiently.

Action Parameters

Action Response

Retrieves all log entries associated with a specific incident in pagerduty. this endpoint provides a comprehensive history of actions, notifications, and status changes related to the incident. it should be used when detailed information about the lifecycle of an incident is needed, such as for post-incident reviews, auditing, or tracking the incident resolution process. the endpoint returns log entries in chronological order, allowing users to trace the incident’s progression from creation to resolution. note that the number of log entries returned may be large for long-running or complex incidents, so pagination might be necessary (though not specified in the given schema).

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

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

Deletes a specific cache variable associated with an event orchestration in pagerduty. this endpoint is used to remove temporary data storage that was previously set up for use in event orchestration workflows. it should be used when you need to clean up or remove outdated cache variables that are no longer needed in your event management process. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint requires both the event orchestration id and the specific cache variable id to ensure precise removal of the intended data.

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

Creates a new change event in the pagerduty system. this endpoint allows you to record and track significant changes or updates within your infrastructure or services. use this when you want to log important modifications, deployments, or system alterations that may impact incident management or operational processes. the change event data can be used for correlation with incidents, providing context for potential issues or for auditing purposes. this endpoint is particularly useful for maintaining a comprehensive change log and enhancing the incident response process by providing additional context about recent system changes.

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

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

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

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

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

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

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

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

This endpoint removes a team’s association from a specific automation action runner in pagerduty. it is used to revoke a team’s access to execute or manage tasks on a particular runner. the operation is permanent and should be used when you no longer want a team to have access to the runner’s capabilities. this action is typically performed for security reasons, organizational changes, or when refining access control within your pagerduty environment. note that this endpoint only removes the association; it does not delete the runner or the team themselves.

Action Parameters

Action Response

Retrieves and aggregates analytics metrics for incidents related to escalation policies in pagerduty. this endpoint allows for detailed filtering and customization of incident data, enabling users to analyze trends, performance, and patterns in their incident management process. it’s particularly useful for generating reports, identifying areas for improvement, and understanding the effectiveness of escalation policies over time. the endpoint supports various filtering options, time zone specifications, and time-based aggregation, making it a powerful tool for operational insights and decision-making in incident management.

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

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

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

This endpoint retrieves and aggregates analytics metrics for incidents across all teams in pagerduty. it allows users to apply various filters and parameters to analyze incident data, such as creation date range, urgency, team associations, and more. the endpoint is particularly useful for generating reports, identifying trends, and performing operational reviews across multiple teams and services. it provides flexibility in data aggregation and sorting, enabling users to customize their analysis based on specific needs and time frames. however, users should be aware of the one-year limitation on the date range when using the created at filters.

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

Deletes a specific automation runner from the pagerduty system. this endpoint is used to permanently remove an automation runner, which is responsible for executing automated tasks and workflows. it should be used when an automation runner is no longer needed or needs to be replaced. once deleted, all associated automated actions and schedules tied to this runner will be affected. exercise caution when using this endpoint, as the deletion is irreversible and may impact existing automation setups.

Action Parameters

Action Response

Subscribes specified users or teams to receive status updates for a particular incident in pagerduty. this endpoint allows you to add multiple subscribers at once, ensuring that relevant parties are kept informed about the incident’s progress. it’s particularly useful when you need to involve additional stakeholders or support teams during an ongoing incident. the endpoint requires the incident id and a list of subscribers, each defined by their unique id and type (user or team). use this when you want to expand the notification list for critical updates about an incident, but be mindful not to oversubscribe, as it may lead to notification fatigue.

Action Parameters

Action Response

The listbusinessservices endpoint retrieves a comprehensive list of all business services configured within a pagerduty account. this get operation provides an overview of the critical business functions monitored and managed through pagerduty’s incident management platform. it’s particularly useful for obtaining a holistic view of an organization’s service hierarchy, conducting audits, or integrating service information with other systems. while the endpoint doesn’t appear to offer filtering or pagination options, it serves as a fundamental tool for understanding the scope of services under management. users should be aware that the response may include a large amount of data for accounts with numerous business services, potentially impacting response times for accounts with extensive service catalogs.

Action Parameters

Action Response

This endpoint allows updating an existing user’s information in pagerduty. it is used to modify various attributes of a user’s profile, including their name, email, time zone, role, and other details. the endpoint requires the user’s id in the url path and accepts a json object containing the updated user information in the request body. it’s particularly useful for maintaining up-to-date user records, changing user roles, or updating contact information. note that some fields, such as teams and contact methods, are read-only and cannot be modified through this endpoint.

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

Updates an existing ruleset in the pagerduty incident management system. this endpoint allows you to modify the name of a ruleset or change its team association. it’s used when you need to adjust the configuration of a specific ruleset, such as renaming it for better clarity or reassigning it to a different team. the endpoint requires the ruleset’s unique id and accepts updates to the name and team fields. it’s important to note that other fields like routing keys, creation details, and update history are read-only and cannot be modified through this call. this endpoint is particularly useful for maintaining and organizing rulesets as your incident management needs evolve.

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 schedule in pagerduty using its unique identifier. this endpoint is essential for viewing the configuration of an existing on-call schedule, including its name, time periods, rotation layers, and associated users or teams. use this when you need to inspect a schedule’s current setup, verify on-call assignments, or gather data for schedule management tasks. the endpoint provides a comprehensive view of a single schedule but does not allow modifications; for updates, a separate put request would be required.

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

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

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

Retrieves alerts associated with paused incident reports in pagerduty. this endpoint allows users to fetch information about alerts that have been temporarily halted in the reporting process. it’s useful for reviewing and managing incidents that have been paused, potentially for prioritization or during maintenance periods. the endpoint returns a list of alerts related to paused incident reports, which can help in assessing the current state of incident management and decision-making for further actions. note that this endpoint only provides information about paused alerts and does not include details about active or resolved incidents.

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 updates an existing custom field for incidents in pagerduty. it allows you to modify the display name, description, and default value of a custom field identified by its unique field id. use this endpoint when you need to change the properties of a custom field, such as renaming it, updating its description, or setting a new default value. the update maintains data integrity by enforcing specific constraints on field properties, ensuring consistency across the pagerduty incident management system. note that updating a custom field affects all incidents that use this field, so use this endpoint cautiously in production environments.

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

Creates a new ruleset in pagerduty for managing incident routing and notification rules. this endpoint allows you to define a named set of rules that determine how incidents are processed and directed to specific teams or users. it’s particularly useful when setting up or modifying your incident management workflow. the created ruleset can be global, affecting all incoming incidents, or assigned to a specific team for more targeted incident routing. note that while you can create the ruleset structure with this call, the actual rules within the ruleset must be added separately using other api endpoints.

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

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

Invokes a specific automation action in pagerduty, associating it with a particular incident. this endpoint allows you to trigger pre-defined automated tasks or workflows within the pagerduty incident management system. it’s particularly useful for executing custom actions or scripts in response to specific incidents, enhancing the incident response process. the action is identified by its unique id, and the invocation must be linked to an existing incident through its incident id. this endpoint should be used when you need to programmatically execute automation actions as part of your incident management workflow or integration with other systems.

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

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

This endpoint unsubscribes specified users or teams from receiving notifications for a particular business service in pagerduty. it allows bulk unsubscription of multiple entities in a single api call. the endpoint should be used when you need to remove one or more users or teams from the notification list of a specific business service, such as when reorganizing team responsibilities or updating notification preferences. it’s important to note that this action is immediate and irreversible, so care should be taken to ensure the correct entities are being unsubscribed. the endpoint doesn’t provide a way to confirm or preview the changes before they’re applied, so it’s recommended to double-check the subscriber information before making the api call.

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 the on-call handoff notification rules for a specific user in pagerduty. this endpoint allows you to fetch the configured rules that determine how and when a user is notified about on-call schedule transitions. it’s particularly useful for understanding and auditing a user’s notification preferences during shift changes or when responsibilities are transferred between team members. the retrieved rules may include settings for different notification methods (e.g., email, sms, push notifications) and timing preferences relative to the handoff. this endpoint should be used when you need to review or manage a user’s on-call handoff communication settings, but it does not allow for modification of these rules.

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 postmortem analysis for a specific post on a pagerduty status page. this endpoint allows users to access detailed information about an incident after it has been resolved, including root cause analysis, timeline of events, and lessons learned. it should be used when detailed information about the resolution of a specific incident is needed, particularly for review, documentation, or improvement purposes. the endpoint is valuable for teams conducting thorough post-incident reviews or for maintaining a knowledge base of past incidents and their resolutions. note that this endpoint only provides postmortem information and does not allow for modifications to the postmortem content.

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

Retrieves detailed information about a specific pagerduty service using its unique identifier. this endpoint allows users to access configuration details, integration settings, and other relevant information for a particular service within their pagerduty account. it’s essential for managing and monitoring the status of individual services, which are core components in pagerduty’s incident management system. use this endpoint when you need to inspect or verify the configuration of a specific service, such as before making updates or troubleshooting issues related to that service. the endpoint provides a comprehensive view of the service but does not allow modifications; for updates, a separate put or patch endpoint would be required.

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