Get Started
- Introduction
- Quickstart
Documentation
- Data Sources
- Business Objects
- Business Graph™
- Knowledge
- Query Agent
- Reports
- Subscriptions
- Destinations
- Tools
- Introduction
- Ably
- Acculynx
- Active campaign
- Affinity
- Agencyzoom
- Ahrefs
- Airtable
- Alchemy
- Amplitude
- Apaleo
- Apollo
- Asana
- Attio
- Bamboohr
- Bannerbear
- Baserow
- Bill
- Bitbucket
- Blackboard
- Bolna
- Borneo
- Box
- Brevo
- Browseai
- Browserbase tool
- Bugbug
- Cal
- Calendly
- Canva
- Canvas
- Chatwork
- Clickup
- Coda
- Codeinterpreter
- Coinbase
- Composio
- Composio search
- Confluence
- Contentful
- Crustdata
- D2lbrightspace
- Dialpad
- Discord
- Discordbot
- Docusign
- Dropbox
- Dynamics365
- Echtpost
- Elevenlabs
- Entelligence
- Exa
- Excel
- Figma
- Firecrawl
- Fireflies
- Flutterwave
- Formsite
- Foursquare
- Freshdesk
- Github
- Gmail
- Gong
- Google maps
- Googleads
- Googlebigquery
- Googlecalendar
- Googledocs
- Googledrive
- Googlemeet
- Googlephotos
- Googlesheets
- Googlesuper
- Googletasks
- Gorgias
- Hackernews
- Heygen
- Hubspot
- Humanloop
- Intercom
- Jira
- Junglescout
- Klaviyo
- Kommo
- Linear
- Linkedin
- Linkhut
- Linkup
- Listennotes
- Lmnt
- Mailchimp
- Mem0
- Metaads
- Microsoft clarity
- Microsoft teams
- Mixpanel
- Monday
- More trees
- Neon
- Ngrok
- Notion
- One drive
- Onepage
- Open sea
- Outlook
- Pagerduty
- Pandadoc
- Peopledatalabs
- Perplexityai
- Pipedrive
- Placekey
- Posthog
- Quickbooks
- Ramp
- Recallai
- Reddit
- Resend
- Retellai
- Rocketlane
- Rootly
- Salesforce
- Semanticscholar
- Semrush
- Sendgrid
- Sentry
- Serpapi
- Servicenow
- Share point
- Shopify
- Shortcut
- Simplesat
- Slack
- Slack user
- Slackbot
- Snowflake
- Stripe
- Supabase
- Tavily
- Text to pdf
- Textrazor
- Tinyurl
- Todoist
- Trello
- Twitter
- Twitter media
- Typefully
- Weathermap
- Webflow
- Whatsapp
- Workiom
- Wrike
- Yousearch
- Youtube
- Zendesk
- Zenrows
- Zoho
- Zoom
- Zoominfo
- Admin
Changelog
Pagerduty
Integrate PagerDuty to manage incidents, schedules, and alerts directly from your application.
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.
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.
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.
Associates multiple service dependencies in pagerduty, allowing you to define relationships between supporting and dependent services. this endpoint is used to establish a hierarchical structure of services, which is crucial for effective incident management and impact analysis. it enables you to create multiple dependencies in a single api call, improving efficiency when setting up complex service relationships. use this endpoint when you need to define or update the dependency structure of your services in pagerduty, such as during initial setup, service restructuring, or when adding new services to your incident management workflow.
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.
This endpoint analyzes and aggregates incident metrics across all escalation policies in pagerduty. it allows for detailed filtering and customization of the analysis, enabling users to gain insights into incident patterns, response times, and escalation effectiveness. the endpoint is particularly useful for operational reviews, performance analysis, and identifying areas for improvement in incident management processes. it provides flexibility in data selection through various filters and supports different time-based aggregations for comprehensive reporting.
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.
Create a custom field for an incident type. custom fields (cf) are a feature which will allow customers to extend incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. custom fields can be applied to different incident types. <!— theme: warning —> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: custom fields.write
Retrieves the count of paused incident reports in the pagerduty system. this endpoint is part of pagerduty’s incident management and analytics features, providing a quick way to quantify the number of incidents that are currently in a paused state. it’s particularly useful for generating high-level analytics, tracking incident management efficiency, and identifying trends in incident handling. the endpoint returns a simple count, making it ideal for dashboard displays or periodic system status checks. it should be used when a rapid overview of paused incidents is needed, but it won’t provide detailed information about individual incidents.
Converts the rules associated with a specific pagerduty service to a new or optimized format. this endpoint is used to update and standardize the incident management rules for a given service, improving the efficiency and consistency of alert handling. it should be used when there’s a need to modernize rule sets, apply best practices, or adapt rules to changing service requirements. the conversion process is applied to all rules linked to the specified service id, potentially modifying their structure or behavior. it’s important to note that this operation may impact existing incident routing and alerting patterns, so it should be used cautiously and preferably during a maintenance window.
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.
Create a new incident type. incident types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. <!— theme: warning —> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. for more information see the api concepts document scoped oauth requires: incident types.write
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.
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.
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.
Creates a new extension in pagerduty, allowing for additional functionality or integrations to be added to your services. this endpoint is used to set up webhooks, custom integrations, or other specific features that enhance the capabilities of your pagerduty account. the extension is defined by its name, associated services, and a specific extension schema that determines its behavior. use this endpoint when you need to automate the creation of extensions, such as setting up multiple webhooks or implementing custom workflows. it’s particularly useful for large-scale deployments or when programmatically managing your pagerduty configuration. note that the extension can be temporarily disabled by pagerduty if issues arise, such as repeated rejections from a webhook server.
Creates a new on-call handoff notification rule for a specific user in pagerduty. this endpoint allows you to set up automated notifications for when a user is about to start or end their on-call shift. it defines how and when the user should be notified about upcoming handoffs, helping to ensure smooth transitions between on-call periods. use this when you need to establish or modify the way a user is informed about their on-call responsibilities. the rule can be set for incoming shifts, outgoing shifts, or both, and can use various contact methods like email, phone, push notifications, or sms. note that this endpoint creates a new rule and does not modify existing ones.
This endpoint creates a new business service in pagerduty, which represents a specific service or application that can be monitored and managed within the incident management platform. it allows you to define essential properties of the service, including its name, description, point of contact, and the team responsible for it. use this endpoint when you need to add a new service to your pagerduty account for monitoring and incident management. the created business service can be later associated with technical services, incidents, and escalation policies. note that this endpoint only creates the business service; additional configuration may be required to set up monitoring and alerting for the service.
Delete a field option for a custom field. <!— theme: warning —> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: custom fields.write
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.
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. <!— theme: warning —> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: custom fields.write
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.
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.
Create new incident workflow trigger scoped oauth requires: incident workflows.write
Deletes a specific incident workflow from the pagerduty system. this endpoint should be used when you want to permanently remove a customized sequence of automated actions and triggers associated with incident management. it’s important to note that this action is irreversible, and once deleted, the workflow cannot be recovered. use this endpoint with caution, ensuring that the workflow is no longer needed before deletion. this operation helps in maintaining a clean and relevant set of incident workflows, improving overall incident management efficiency.
Create a field option 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. <!— theme: warning —> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: custom fields.write
Creates a new escalation policy in pagerduty, defining how incidents are escalated to different responders or teams. this endpoint allows you to set up a structured response plan for managing incidents, including escalation rules, targets, and associated services or teams. use this when setting up or modifying incident management workflows. the created policy determines the sequence of notifications and assignments for unacknowledged incidents. note that while you can create the policy structure, actual service associations are read-only and must be managed separately. only one team can be associated with a policy, and the account must have the ‘teams’ ability to use this feature.
Creates a new event rule within a specified ruleset in pagerduty’s incident management system. this endpoint allows you to define complex conditions for event matching and specify actions to be taken when an event meets those conditions. use this to automate incident response, customize alert routing, and fine-tune event processing based on specific criteria. the created rule becomes part of the ruleset’s evaluation sequence, affecting how incoming events are processed and managed.
Creates a new post on a specified pagerduty status page. this endpoint allows you to publish information about incidents or scheduled maintenance, including details such as the post type, timing, and associated updates. use this to communicate service status, planned downtime, or ongoing issues to your users or customers. the post can include multiple updates, each with its own message, severity, and impact on specific services. this is particularly useful for providing real-time information during incidents or for scheduling and describing maintenance windows.
Creates a new field option for a specific custom field in pagerduty’s incident management system. this endpoint allows you to add predefined options to custom fields, enhancing the ability to categorize and filter incidents with consistent, structured data. use this when you need to expand the list of selectable values for a string-type custom field. the new option becomes immediately available for selection when updating or creating incidents. note that this operation is specific to custom fields of type ‘string’ and cannot be used for other data types. ensure that the field id in the url corresponds to an existing custom field in your pagerduty account.
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.
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.
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.
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.
Deletes a specific rule from a pagerduty service. this endpoint is used to permanently remove a rule that defines conditions for incident creation or automation within a particular service. it should be used when you need to eliminate an outdated, incorrect, or no longer needed rule from your service configuration. the operation cannot be undone, so use it with caution. this endpoint does not return the deleted rule’s details; it only confirms the successful deletion.
Deletes a specific ruleset from the pagerduty system based on the provided id. this endpoint should be used when you need to remove an existing ruleset, which may be necessary during incident management reconfiguration or when cleaning up obsolete rulesets. the deletion is permanent and cannot be undone, so use this endpoint with caution. it’s important to note that deleting a ruleset will affect the incident routing and escalation policies associated with it, potentially impacting your organization’s incident response workflow.
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.
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.
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.
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.
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.
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.
This endpoint allows you to delete a postmortem associated with a specific post on a pagerduty status page. it is used to remove the detailed analysis and lessons learned from an incident after it has been resolved and documented. this action is permanent and should be used with caution, as it will remove valuable information about past incidents. the endpoint is particularly useful for maintaining the relevance of status page content, removing outdated postmortems, or correcting information that should not have been published. it’s important to note that this operation cannot be undone, so it’s recommended to have a backup of the postmortem content before deletion if retention of this information is necessary for internal records.
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.
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.
Deletes a specific status update notification rule associated with a user in the pagerduty system. this endpoint allows administrators or users with appropriate permissions to remove custom notification rules for status updates, helping to manage and streamline the user’s notification preferences. it should be used when a particular status update notification rule is no longer needed or requires removal from the user’s settings. the operation is irreversible, so caution should be exercised when invoking this endpoint. it’s important to note that this endpoint only removes the specified rule and does not affect other notification rules or user settings.
Create a new workflow integration connection. scoped oauth requires: workflow integrations:connections.write
Creates or updates a post update on a specific pagerduty status page. this endpoint allows you to add new information or modify existing updates related to an incident or maintenance event. use this when you need to communicate changes in status, provide additional details, or update the severity of an ongoing situation. the post update can include a custom message, current status, severity level, and list of impacted services. you can also control whether subscribers should be notified and optionally schedule future updates. this tool is essential for maintaining clear and timely communication with stakeholders during incidents or planned maintenance periods. note that this endpoint does not create new status page posts; it only adds updates to existing posts.
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.
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.
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.
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.
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.
Creates a new incident in pagerduty with specified details and assignments. use this endpoint when an event requires immediate attention from on-call teams. it supports comprehensive incident documentation, including priority, urgency, and conference bridge information. the ‘incident key’ parameter helps prevent duplicate incidents, crucial for maintaining a clean incident list.
Creates a new response play in pagerduty, which is a predefined set of actions to be executed in response to an incident. this endpoint allows you to configure automated responses, including adding subscribers, assigning responders, setting up conference details, and defining how the response play can be triggered. use this when you want to standardize and automate your incident management process, ensuring consistent and efficient responses to different types of incidents. the response play can be set to run automatically for specific services or be manually triggered by team members or responders, depending on the configuration. this tool is particularly useful for creating templated responses for common incident types or for implementing best practices across your organization’s incident management workflow.
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.
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.
Deletes a specific maintenance window in pagerduty’s incident management system. this endpoint is used to permanently remove a scheduled maintenance window, effectively re-enabling any services and integrations that were temporarily disabled during the maintenance period. it should be used when a maintenance window is no longer needed or was created in error. once deleted, the maintenance window cannot be recovered, so caution should be exercised when using this endpoint. this operation is particularly useful for cleaning up obsolete maintenance windows or adjusting scheduled maintenance plans.
Permanently removes a specific escalation policy from the pagerduty system. this endpoint should be used when an escalation policy is no longer needed or has become obsolete. once deleted, the escalation policy cannot be recovered, and any services or incidents associated with it will need to be reassigned. exercise caution when using this endpoint, as it will impact incident routing and may affect your team’s ability to respond to alerts if not properly managed. it’s recommended to review and update any dependent services before deleting an escalation policy.
Delete a workflow integration connection. scoped oauth requires: workflow integrations:connections.write
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.
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.
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.
Enables a specific extension in the pagerduty system. this endpoint is used to activate an extension that has been previously configured but is currently inactive. it allows users to turn on additional functionalities or integrations within their pagerduty account. the extension is identified by its unique id, which must be provided in the request path. this action is typically used when setting up new integrations, reactivating temporarily disabled features, or as part of automated workflows for managing pagerduty configurations. note that enabling an extension may have immediate effects on the account’s behavior, such as allowing new types of alerts or activating connections with external services.
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.
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.
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.
The updatewebhooksubscription endpoint allows you to modify an existing webhook subscription in pagerduty. this put method enables users to update the events they want to be notified about, change the filter criteria for triggering notifications, update the subscription’s description, and toggle its active state. it’s particularly useful for adjusting notification preferences as your incident management needs evolve. the endpoint requires specifying the webhook subscription id in the url path and accepts a json body with the updated subscription details. note that while you can update multiple aspects of the subscription, you must provide at least the ‘events’ array in your request. be cautious when updating filters, as this can significantly change which incidents trigger notifications.
Executes a predefined response play for a specific incident in pagerduty. this endpoint allows you to trigger a sequence of automated actions designed to manage and respond to the given incident. it’s useful for standardizing and streamlining your incident response process, ensuring consistent handling of similar incidents. the endpoint requires you to specify the incident for which the response play should be run, using the incident’s unique identifier. note that the response play itself is identified by the id in the url path, not in the request body.
Deletes a specific user from the pagerduty system using their unique identifier. this endpoint should be used when you need to permanently remove a user’s account, such as when an employee leaves the organization or no longer requires access to the incident management system. it’s important to note that deleting a user is irreversible and will remove all associated data, including their contact information, notification rules, and incident history. before deletion, ensure that any ongoing incidents or schedules involving this user are reassigned to prevent disruptions in incident management workflows. this operation cannot be undone, so it should be used with caution and only when absolutely necessary.
Deletes a specific add-on from the pagerduty account using its unique identifier. this endpoint should be used when you want to remove an integration or extension that is no longer needed or active in your pagerduty setup. it’s important to note that this action is irreversible, and once an add-on is deleted, it cannot be recovered without re-adding it. use this endpoint with caution, as removing an add-on may impact any automated workflows or integrations that depend on it.
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.
Deletes a specific template from the pagerduty account. this endpoint is used to permanently remove a template configuration, which can be useful for cleaning up outdated or unnecessary incident response plans. once deleted, the template cannot be recovered, so use this operation with caution. it should be used when you no longer need a particular template for incident management or when you want to replace an old template with a new one. this operation does not affect any ongoing incidents that may have been created using the template.
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.
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.
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.
Retrieves detailed information about a specific cache variable within an event orchestration in pagerduty. this endpoint allows users to fetch the current state and configuration of a cache variable, which is used to store temporary data for optimizing event orchestration performance. it’s particularly useful when you need to inspect or debug the cached data being used in your event orchestration workflows. the endpoint should be used when you need to verify the contents of a specific cache variable or when troubleshooting issues related to event orchestration data caching. note that this endpoint only provides read access to the cache variable and cannot be used to modify its contents.
Deletes a specific event orchestration from the pagerduty system. this endpoint should be used when you want to permanently remove an event orchestration configuration, including all its associated rules and routing logic. it’s important to note that this action is irreversible, and once an event orchestration is deleted, it cannot be recovered. before using this endpoint, ensure that the event orchestration is no longer needed and that its deletion won’t disrupt any critical event routing or automation processes in your pagerduty setup. this endpoint is particularly useful during cleanup operations or when restructuring your event management workflow.
Retrieves raw analytics data for a specific incident in pagerduty. this endpoint provides unprocessed incident information, allowing for detailed analysis and custom reporting. it should be used when in-depth, granular data about a particular incident is needed, such as for investigating complex issues or generating custom analytics. the endpoint returns comprehensive incident details, which may include timestamps, status changes, assignee information, and other relevant metrics. however, it does not provide pre-analyzed or aggregated data; users will need to process the raw data themselves for specific insights.
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.
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.
Creates a new event rule for a specific service in pagerduty. this endpoint allows you to define complex conditions and actions for handling incoming events, enabling automated incident management and alert routing. use this when you need to set up custom logic for processing events, such as setting priorities, annotating incidents, or suppressing alerts based on specific criteria. the rule’s position in the evaluation order can be specified, and various time-based conditions can be applied to control when the rule is active. this endpoint is crucial for fine-tuning your incident response workflow and reducing alert noise.
Retrieves a list of escalation policies configured in the pagerduty account. this endpoint allows users to access detailed information about how incidents are escalated within their organization, including the sequence of notifications and assignments for different teams or individuals. it’s particularly useful for reviewing and auditing the incident response process, ensuring that critical alerts are properly routed and escalated. the endpoint provides a comprehensive view of all escalation policies, which is essential for maintaining an effective incident management strategy. however, it does not modify any existing policies or create new ones; it’s purely for retrieval and review purposes.
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.
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.
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.
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.
Retrieves a list of existing priorities in the pagerduty system, ordered from most severe to least severe. this endpoint should be used when you need to obtain information about the current priority levels configured in your pagerduty account. it’s particularly useful for integrations that need to reference or display priority information, or for administrators who want to review the existing priority structure. the endpoint provides a read-only view of priorities and does not allow for creation, modification, or deletion of priority levels. keep in mind that this api call is subject to rate limiting, so it should not be called excessively in short periods.
Retrieves a list of teams associated with a specific automation action runner in pagerduty. this endpoint allows users to identify which teams have access to or are responsible for a particular runner, facilitating better management and organization of automation resources. it’s particularly useful for administrators who need to audit runner permissions or when planning to modify team access to automation capabilities. the endpoint returns team information related to the specified runner only and does not provide details about the runner itself or its automation actions.
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.
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.
Retrieves a list of event orchestrations configured in the pagerduty account. event orchestrations are used to manage and automate the routing and handling of events and incidents. this endpoint allows you to fetch details about existing orchestrations, which can be useful for auditing, reporting, or managing your incident response workflows. the response typically includes information such as orchestration names, associated routing keys, and configured rules. use this endpoint when you need to review or list the current event orchestrations in your pagerduty setup. note that this endpoint does not provide real-time event data or incident details, only the configuration of the orchestrations themselves.
This endpoint deletes a specific override from a pagerduty schedule. it allows users to remove temporary changes made to the regular schedule, reverting it back to its original state. this operation is useful for canceling previously set overrides that are no longer needed, such as temporary shift changes or one-time schedule adjustments. the deletion is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly helpful for maintaining schedule integrity and ensuring that only current and relevant overrides remain active.
Retrieves a list of incidents from pagerduty based on specified criteria. this endpoint allows users to fetch multiple incidents, making it useful for incident management, reporting, and analysis. it supports filtering by status and date range, as well as pagination for handling large result sets. the endpoint is particularly valuable for obtaining an overview of recent or ongoing incidents, tracking incident trends, or integrating pagerduty incident data into external systems or dashboards. note that while this endpoint provides a summary of incidents, it may not include full details for each incident; separate api calls might be necessary to fetch comprehensive information for individual incidents.
This endpoint deletes a specific field option from a custom field in pagerduty’s incident management system. it allows you to remove predefined options that are no longer needed or relevant for incident categorization or data collection. use this endpoint when you want to update the available options for a custom field by removing outdated or unnecessary choices. be cautious when using this endpoint, as deleting a field option may impact existing incidents that use this option and could affect reporting or automation based on these custom fields. this operation cannot be undone, so it’s advisable to have a backup of your custom field configuration before making changes.
Creates a new integration within an existing event orchestration in pagerduty. this endpoint allows users to set up connections between pagerduty and external systems or services, enabling automated event management and incident response. it should be used when adding a new integration to an event orchestration, such as connecting a monitoring tool or alerting system. the endpoint requires minimal information, focusing on the integration’s label for identification purposes. note that this endpoint only creates the integration; additional configuration may be required in the pagerduty interface or through other api calls to fully set up the integration’s functionality.
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
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.
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.
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.
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.
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.
This endpoint deletes a specific post from a pagerduty status page. it is used to remove outdated or irrelevant information from a status page, helping to maintain clear and accurate communication with users about service status. the operation is irreversible, so it should be used with caution. this endpoint is particularly useful for cleaning up resolved incidents or removing erroneous updates. it does not provide any ability to modify or retrieve post content; it only removes the specified post entirely from the status page.
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.
This endpoint deletes a specific post update from a status page post in pagerduty. it allows users to remove outdated or incorrect information from a status page, ensuring that only relevant and accurate updates are displayed. the endpoint should be used when an organization needs to retract or remove a previously published update on their status page. it’s important to note that this action is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly useful for maintaining the accuracy and relevance of status page communications during incident management or scheduled maintenance periods.
Deletes a specific automation action from the pagerduty system. this endpoint is used to permanently remove an automation action, which includes any associated scripts or jobs in runbook automation. it should be used when an automation action is no longer needed or has become obsolete. once deleted, the action cannot be recovered, so use this endpoint with caution. this operation is typically performed by administrators or users with appropriate permissions to manage automation actions.
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.
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.
This endpoint removes a specific automation action from a particular service in pagerduty. it is used to disassociate an automated workflow or action from a service, effectively stopping that action from being triggered for incidents related to the specified service. this operation is useful when you need to update your incident management workflow or when an automated action is no longer relevant for a specific service. it’s important to note that this endpoint only removes the association between the action and the service; it does not delete the automation action itself from the system. use this endpoint with caution, as removing an automation action from a service will immediately affect the incident response process for that service.
Creates a new team within your pagerduty account. this endpoint allows you to establish a group of users with shared responsibilities, often used for organizing incident management and on-call schedules. use this when setting up a new department, project team, or any other group that needs to collaborate on incident responses. the created team can be configured as public or private, determining the level of access for non-members. note that while you can create the team structure with this call, you’ll need separate api calls to add members or assign schedules to the team.
Creates a new tag in pagerduty for labeling and categorizing entities. this endpoint allows users to add a custom label to their pagerduty account, which can be used to organize and filter various resources such as incidents, services, or teams. the created tag can be subsequently assigned to relevant entities to improve organization and searchability within the pagerduty platform. use this endpoint when you need to introduce a new categorization or labeling scheme in your pagerduty setup. note that this endpoint only creates the tag; assigning it to specific entities would require separate api calls.
Creates a new user in the pagerduty system with the specified attributes. this endpoint should be used when onboarding new team members or adding users to your pagerduty account. it allows you to set up essential user information, including name, email, role, and time zone preferences. the created user will have default contact methods and notification rules, which can be customized later. note that some fields like teams, contact methods, and notification rules cannot be set during user creation and must be managed separately. the endpoint requires at minimum a name, email, and user type, with several optional fields for further customization.
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.
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.
Get the status of all oauth delegations revocation requests for this account, specifically how many requests are still pending. this endpoint is limited to account owners and admins. scoped oauth requires: oauth delegations.read
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.
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.
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.
Retrieves the cache variables associated with a specific service in pagerduty’s event orchestration system. this endpoint allows you to access temporary storage data used within event orchestration workflows for the specified service. it’s particularly useful for debugging, auditing, or analyzing the current state of event handling for a service. the retrieved cache variables can provide insights into how events are being processed and what data is being stored temporarily during orchestration. this endpoint should be used when you need to inspect or verify the cache variables for a particular service, which can be helpful in troubleshooting or optimizing event orchestration workflows.
Retrieves the current priority threshold settings for all business services in pagerduty. this endpoint allows users to fetch the configured thresholds that determine incident prioritization and escalation for each business service. it should be used when auditing or reviewing the current priority configurations across the organization’s services. the tool provides a comprehensive view of how incidents are categorized and escalated based on their severity for different business services. it does not allow modification of these thresholds; for changes, a separate update endpoint would be required.
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.
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.
Retrieves detailed information about a specific alert associated with a particular incident in pagerduty. this endpoint is used when you need to access the properties and current state of an individual alert within the context of its parent incident. it’s particularly useful for tracking the progression of an alert, understanding its current status, and gathering related metadata. the endpoint should be called when detailed information about a single alert is required, rather than for bulk operations or listing multiple alerts. note that this endpoint focuses on retrieving data and does not modify the alert or incident.
Retrieves detailed information about a specific maintenance window in pagerduty. this endpoint allows users to access the configuration, schedule, and status of a particular maintenance window using its unique identifier. it’s useful for reviewing planned maintenance periods, verifying window settings, or checking the current status of a maintenance window. the endpoint should be used when detailed information about a single maintenance window is needed, rather than for listing all maintenance windows or creating new ones.
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.
Retrieves a list of vendors or third-party integrations available in the pagerduty platform. this endpoint allows users to access information about various services and tools that can be integrated with pagerduty for enhanced incident management and alerting capabilities. use this endpoint when you need to explore or review the available integrations, such as monitoring tools, ticketing systems, or communication platforms. the response likely includes details such as vendor names, integration types, and possibly configuration options. note that this endpoint does not provide real-time status of integrations or perform any actions on the integrations themselves.
Retrieves detailed information about a specific automation action in pagerduty’s incident management platform. this endpoint allows users to fetch the configuration and attributes of a predefined automation action by its unique identifier. it’s particularly useful when you need to review or audit the settings of an existing automation action, such as its triggers, conditions, or associated workflows. the endpoint should be used when detailed information about a single automation action is required, rather than for listing multiple actions. note that this endpoint only provides read access to the automation action details and cannot be used to modify the action.
Retrieves a list of subscribers for a specific business service in pagerduty. this endpoint allows you to fetch all users or teams configured to receive notifications for incidents related to the specified business service. it’s useful for auditing who is responsible for responding to issues within a particular service, or for managing notification settings at a service level. the endpoint returns read-only data and does not modify any configurations. use this when you need to review or verify the current subscriber list for a business service, such as during incident response planning or service ownership reviews.
Analyzes and aggregates incident metrics across teams in pagerduty, allowing for detailed filtering and customization of results. this endpoint is used to gain insights into incident patterns, team performance, and overall operational efficiency. it provides flexible options for data selection, time range specification, and result presentation, making it valuable for generating reports, identifying trends, and optimizing incident management processes. the endpoint is particularly useful for operational reviews, team performance assessments, and strategic planning in incident response.
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.
Retrieves detailed information about a specific subscription associated with a particular status page in pagerduty. this endpoint allows users to fetch subscription details such as the subscriber’s contact information, notification preferences, and current subscription status. it should be used when you need to review or verify the details of an existing subscription for a status page. the endpoint is particularly useful for managing and auditing subscriber information, troubleshooting notification issues, or when updating subscription settings. note that this endpoint only provides read access to subscription data and cannot be used to modify or create new subscriptions.
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.
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.
Retrieves detailed information about a specific rule within a pagerduty ruleset. this endpoint allows users to fetch the configuration and settings of an individual rule, which is essential for understanding how incidents are being automated and managed. it should be used when detailed information about a particular rule’s conditions, actions, or other properties is needed. this endpoint is particularly useful for auditing ruleset configurations, troubleshooting automation issues, or preparing to update rule settings. it does not modify any data and is safe for frequent use in monitoring or dashboard applications. however, it will not provide an overview of all rules in a ruleset or allow for rule modifications.
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.
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.
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.
Retrieves detailed information about a specific automation action runner in pagerduty. this endpoint allows users to fetch the configuration, status, and other relevant details of a runner by providing its unique identifier. it’s particularly useful for monitoring the health and settings of individual runners, which are crucial components in pagerduty’s automated incident response system. this tool should be used when you need to inspect or verify the properties of a specific runner, such as its connection status, associated scripts, or execution environment. it does not modify the runner’s configuration or trigger any actions; it’s purely for information retrieval.
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.
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.
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.
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.
Get 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.read
Get details about a workflow integration. scoped oauth requires: workflow integrations.read
Get details about a workflow integration connection. scoped oauth requires: workflow integrations:connections.read
Retrieves a list of all schedules from your pagerduty account. this endpoint provides essential information about on-call rotations, helping teams manage and organize their incident response workflows. use this when you need to view all existing schedules, such as during schedule audits, team restructuring, or when setting up integrations that require schedule ids. the endpoint returns basic details for each schedule, which can be used to make further api calls for more specific information. note that this endpoint does not provide the full details of each schedule’s rotation patterns; for that, you would need to make additional api calls using the schedule ids returned by this endpoint.
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.
Get a field option on a custom field <!— theme: warning —> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: custom fields.read
List 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. <!— theme: warning —> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: custom fields.read
Retrieves detailed information about a specific automation action’s association with a particular team in pagerduty. this endpoint allows you to examine how an automation action is configured or applied within the context of a specific team. it’s useful for understanding the relationship between automation actions and teams, which can be crucial for managing incident response workflows and team-specific automations. the endpoint should be used when you need to verify or audit the automation action settings for a particular team, or when troubleshooting team-specific automation behaviors.
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.
Retrieves a specific extension schema from pagerduty by its unique identifier. this endpoint is used to fetch detailed information about a custom data structure that extends the functionality of the pagerduty api. it’s particularly useful for developers who need to understand or work with custom fields or data structures in their pagerduty integrations. the endpoint returns the complete definition of the requested extension schema, including any custom fields, their types, and other metadata. this tool should be used when you need to inspect or verify the structure of a specific extension schema, but it won’t allow you to modify the schema or create new ones. keep in mind that access to extension schemas may be subject to account permissions and the schema must exist in the pagerduty account for the request to succeed.
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.
Retrieves all available extension schemas from the pagerduty api. this endpoint allows users to fetch custom schema extensions that have been defined for their pagerduty account. extension schemas are used to add custom data structures or validation rules to the standard api schema, enabling more flexible and tailored data management. this tool is particularly useful when you need to understand the custom data fields or structures that have been added to your pagerduty implementation. it does not create, modify, or delete extension schemas; it only provides a read-only view of the existing schemas.
Retrieves service impacts for a specific status dashboard in pagerduty. this endpoint allows users to fetch real-time information about how incidents or maintenance activities are affecting services displayed on a particular dashboard. it’s useful for monitoring the current state of services, understanding ongoing issues, and assessing the overall health of systems represented in the specified dashboard. the endpoint should be used when you need to programmatically access up-to-date service impact data for a known status dashboard, enabling integration with other monitoring or reporting tools. note that this endpoint only provides information for a single dashboard at a time and requires knowledge of the dashboard’s url slug.
List all workflow integration connections. scoped oauth requires: workflow integrations:connections.read
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).
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.
List the available incident types incident types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. these can be filtered by enabled or disabled types. <!— theme: warning —> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. for more information see the api concepts document scoped oauth requires: incident types.read
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
Retrieves detailed information about a specific impact on a pagerduty status page. this endpoint allows you to fetch the current state and details of a particular impact, such as its severity, affected components, and any updates related to the impact. it’s useful for monitoring the progress of ongoing incidents or reviewing past impacts on your services. the endpoint should be used when you need to get the most up-to-date information about a known impact, especially during incident management or when providing updates to stakeholders. note that this endpoint only provides information about a single impact and does not give an overview of all impacts on a status page.
Retrieves a list of incident workflows configured in the pagerduty account. this endpoint allows users to fetch information about automated sequences of actions set up to respond to incidents. it’s useful for reviewing existing workflows, auditing incident response processes, or gathering data for reporting purposes. the endpoint supports pagination and filtering by workflow name. it does not create, modify, or delete workflows; it’s purely for retrieval of workflow information.
List the custom fields for an incident type. custom fields (cf) are a feature which will allow customers to extend incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. custom fields can be applied to different incident types. <!— theme: warning —> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: custom fields.read
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.
List all workflow integration connections for a specific workflow integration. scoped oauth requires: workflow integrations:connections.read
List available workflow integrations. scoped oauth requires: workflow integrations.read
This endpoint creates or updates an account subscription for a specific business service in pagerduty. it allows users to manage subscription settings, such as notification preferences or service-level agreements, for a particular business service identified by its unique id. use this endpoint when you need to set up new subscription configurations or modify existing ones for a business service. the endpoint is particularly useful for automating subscription management across multiple business services or integrating subscription updates with other systems. note that this operation may affect billing or service access, so it should be used carefully and with proper authorization.
Retrieve an existing incident workflows trigger scoped oauth requires: incident workflows.read
The listlicenses endpoint retrieves a comprehensive list of all licenses associated with the authenticated pagerduty account. this tool is essential for administrators and account managers who need to review, audit, or manage the licensing status of their pagerduty implementation. it provides an overview of all active licenses, including details such as license type, expiration date, and the number of users covered. this endpoint should be used when you need to perform license inventory, plan for renewals, or ensure compliance with your service agreement. note that while it offers a complete view of licenses, it does not provide functionalities to modify licenses directly through the api.
Retrieves a list of all available actions that can be used in incident workflows within pagerduty. this endpoint provides information about the various automated tasks and responses that can be configured to streamline incident management processes. it should be used when setting up or modifying incident workflows to understand the range of actions available for automation. the endpoint returns details about each action, which may include its name, description, and any configurable parameters. this tool is particularly useful for developers and system administrators who are designing or optimizing their incident response procedures in pagerduty. note that while this endpoint retrieves action information, it does not execute or modify any actions itself.
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.
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.
Creates a new cache variable for a specific service in pagerduty’s event orchestrations. this endpoint allows you to define a cache variable that can store either the most recent value from an event field or count trigger events within a specified time range. cache variables are useful for maintaining temporary data related to events, which can be used in event routing and management. the created cache variable can be used to enhance event processing logic and improve incident management workflows.
The analyzerespondermetrics endpoint aggregates and analyzes responder performance metrics for pagerduty incidents. it provides insights into response times, efficiency, and workload distribution. this tool is ideal for assessing and optimizing incident response processes, offering flexible filtering options for focused analysis. note that it provides aggregated data, not real-time information, with a maximum analysis range of one year.
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.
Adds a new note to an existing incident in pagerduty. this endpoint allows users to append additional information, updates, or comments to a specific incident identified by its unique id. it’s particularly useful for documenting the progress of incident resolution, sharing important observations, or recording actions taken. the note content can include any text relevant to the incident management process, helping teams collaborate and maintain a clear record of the incident’s timeline and handling.
Creates a new cache variable within a pagerduty event orchestration. this endpoint allows you to define a cache variable that can store dynamic data related to events, either based on recent values extracted from event fields or by counting trigger events within a specified time range. cache variables are useful for maintaining state across multiple events and can be used in event routing and automation rules. the created cache variable can be configured with conditions to determine when it should be updated and can be optionally disabled. this tool should be used when setting up complex event orchestrations that require stateful processing or when implementing advanced automation workflows in pagerduty.
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.
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.
Retrieves information about the impacts of supporting services on a specific business service in pagerduty. this endpoint is used to understand the relationships and dependencies between a primary business service and its supporting services, along with the potential impacts these relationships may have on incident management and service reliability. it’s particularly useful for assessing the cascading effects of incidents across interconnected services and for proactive risk management. the endpoint should be used when analyzing service dependencies, planning incident response strategies, or evaluating the overall resilience of your service infrastructure. note that this endpoint focuses on impact information and may not provide real-time incident data or detailed metrics about the services themselves.
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.
Retrieves a list of incidents associated with a specific responder in the pagerduty incident management system. this endpoint allows for detailed filtering and pagination of incident data, making it ideal for analyzing a responder’s workload, performance, and incident trends over time. it supports various filter criteria such as creation time range, urgency, major incident status, team and service associations, and priority levels. the tool is particularly useful for generating reports, conducting operational reviews, and optimizing incident response processes. it should be used when detailed incident information for a specific responder is needed, but not for real-time incident updates or for modifying incident data.
Retrieves a list of templates available in the pagerduty system. templates are pre-defined configurations used for creating alerts, notifications, and other automated processes within pagerduty. this endpoint should be used when you need to view or manage the existing templates in your pagerduty account. it provides an overview of all templates, which can be useful for auditing, updating, or selecting templates for use in incident management workflows. the endpoint does not create, modify, or delete templates; it is solely for retrieving template information.
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.
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.
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.
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.
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.
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}.
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.
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.
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.
This endpoint adds a service to an existing automation action in pagerduty. it allows users to associate a specific service with an automation action, enabling the action to be applied to incidents or events related to that service. the endpoint requires the automation action’s id in the url path and a service reference object in the request body. it should be used when configuring or updating automation actions to include additional services in their scope of operation. this endpoint is particularly useful for expanding the reach of automation actions across multiple services within an organization’s pagerduty setup.
Retrieves a list of abilities or capabilities available in the pagerduty system. this endpoint allows users to query and understand the features and functionalities they can access or perform within pagerduty. it’s particularly useful for determining the scope of actions available to the authenticated user or for checking the overall feature set of the pagerduty instance. the endpoint should be used when you need to discover or verify the available abilities, such as during initial setup, permission audits, or when planning integrations. it does not modify any data and is safe to call frequently.
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.
Retrieves the current status of a specific item on a pagerduty status page. this endpoint is used to fetch up-to-date information about the operational state of a particular service or component listed on a status page. it’s particularly useful for integrations that need to monitor or display the latest status of services to users or internal systems. the endpoint requires both the status page id and the specific status item id, allowing for precise querying of individual service statuses within a larger status page context. this tool should be used when you need to programmatically check the current state of a specific service on a pagerduty status page, such as during incident management or for creating custom dashboards.
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.
Retrieves detailed information about a specific status dashboard in pagerduty. this endpoint allows users to fetch the current configuration, components, and status of a particular dashboard, which is crucial for monitoring system health and managing incidents efficiently. it should be used when you need to access up-to-date information about a known status dashboard, such as during incident response or when updating dashboard configurations. the endpoint will not modify any data and is intended for read-only operations.
Retrieves detailed information about a specific ability (feature capability) associated with a pagerduty account using its unique identifier. this endpoint allows users to query the system for the status and details of a particular feature, such as ‘teams’ or ‘incident management’, to determine if it’s available and potentially get additional configuration information. it’s particularly useful when you need to verify the presence of a specific functionality or gather more details about a feature’s implementation in your account. the endpoint should not be used to modify abilities or retrieve information about multiple abilities simultaneously.
This endpoint facilitates the migration of an integration from one event orchestration to another within pagerduty. it allows users to reassign an existing integration to a different event orchestration, maintaining the integration’s configuration while updating its association. this operation is useful when restructuring event management workflows or optimizing incident routing. the endpoint should be used when there’s a need to change how a specific integration interacts with pagerduty’s event processing system. it’s important to note that this process only changes the association and does not modify the integration’s settings or connected external services.
Retrieves the status update notification rules for a specific user in pagerduty. this endpoint allows you to fetch the configured rules that determine how and when a user receives notifications about status changes in incidents or services they are associated with. it’s useful for understanding a user’s current notification preferences and can be helpful when auditing or updating user settings. the endpoint returns a list of notification rules, each detailing the conditions under which status update notifications are sent to the user.
Get detailed information about a single incident type. accepts either an incident type id, or an incident type name. incident types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. <!— theme: warning —> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. for more information see the api concepts document scoped oauth requires: incident types.read
Retrieves the current alert grouping settings for the pagerduty account. this endpoint provides information on how alerts are automatically grouped together in the incident management system. it should be used when you need to understand or audit the current configuration for alert grouping, which can impact how incidents are organized and presented to responders. the endpoint returns the global settings that apply across the account, but it does not provide information about service-specific alert grouping rules or real-time grouping status of active incidents. this information is crucial for administrators managing large-scale incident response processes or when troubleshooting alert noise issues.
Get a custom field for an incident type. custom fields (cf) are a feature which will allow customers to extend incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. custom fields can be applied to different incident types. <!— theme: warning —> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: custom fields.read
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.
Retrieves a list of audit records from the pagerduty system. this endpoint allows users to access logs of configuration changes made to pagerduty resources, such as account objects. the records are sorted by execution time, with the newest records appearing first. this tool is particularly useful for tracking and reviewing changes, conducting security audits, or generating reports on system modifications. it provides a comprehensive view of who made what changes and when, enhancing transparency and accountability within the organization. the endpoint supports pagination and date range filtering to manage large volumes of audit data effectively.
Retrieves the impacts associated with a specific status page in pagerduty. this endpoint allows users to fetch detailed information about service disruptions, incidents, or other events affecting the services displayed on a particular status page. it is useful for monitoring the current state of services, understanding the severity and scope of ongoing issues, and keeping stakeholders informed about service health. the endpoint should be used when there’s a need to programmatically access impact data for a status page, such as for integration with other monitoring tools or for creating custom dashboards.
Posts a status update for a specific incident in pagerduty. this endpoint allows you to add new information or progress reports to an ongoing incident, keeping stakeholders informed about the current state of the issue. it supports both simple text updates and more detailed custom html email updates. use this when you need to communicate important changes, actions taken, or any relevant information about the incident to the team or stakeholders. the endpoint is particularly useful for maintaining a clear timeline of the incident’s progression and ensuring all parties have the most up-to-date information. note that while a simple message is always required, you have the option to provide additional details through a custom html email by including both the ‘subject’ and ‘html message’ fields.
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.
Retrieves all alerts associated with a specific incident in pagerduty. this endpoint allows users to fetch detailed information about the notifications and alerts that were triggered as part of an incident’s lifecycle. it is particularly useful for incident postmortems, auditing purposes, or understanding the notification flow during an incident. the endpoint returns a list of alerts, which may include information such as alert creation time, alert status, and the targets (users or services) that received the notifications. it should be used when detailed alert information for a known incident is required, but it will not provide information about the incident itself beyond its associated alerts.
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.
Provides aggregated metrics for the usage of pd advance. <!— theme: info —> > note: analytics data is updated periodically. it takes up to 24 hours before new incidents appear in the analytics api. scoped oauth requires: analytics.read
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.
Retrieves a list of custom fields associated with incidents in pagerduty. custom fields are additional data points that can be added to incidents to provide more detailed information tailored to specific organizational needs. this endpoint allows you to fetch all defined custom fields, which can be useful for understanding the structure of incident data, preparing for incident creation or updates, or auditing the current custom field configuration. the response will include details such as field names, types, and any predefined options for each custom field. use this endpoint when you need to review or work with the custom field definitions in your pagerduty account, such as when integrating with other systems or preparing reports that involve custom incident data.
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.
Retrieves the impacts of a specific incident on business services within pagerduty. this endpoint allows users to assess the scope and severity of an ongoing incident by providing detailed information about which business services are affected and to what extent. it should be used when there’s a need to understand the broader implications of an incident across the organization’s critical operations. the tool is particularly useful for incident managers, stakeholders, and support teams who need to prioritize response efforts based on the impact severity. note that this endpoint only provides impact data for a single incident at a time and does not offer historical or aggregate impact information across multiple incidents.
Retrieves a list of change events from the pagerduty system within a specified time range. change events represent notifications or updates that occur within a pagerduty account, such as modifications to teams, services, or escalation policies. this endpoint is useful for monitoring and auditing changes in the pagerduty configuration, helping to track system modifications and ensure compliance with change management processes. the response typically includes details about each change event, such as the type of change, affected resources, timestamp, and the user who initiated the change. use this endpoint when you need to review recent changes, investigate system modifications, or generate reports on configuration updates within your pagerduty account.
Retrieves a list of services associated with a specific automation action in pagerduty. this endpoint allows users to fetch all services that are linked to a particular automation action, providing insights into which components or systems are affected by the automated process. it’s useful for auditing automation configurations, understanding the scope of automated actions, and managing incident response workflows. the endpoint should be used when you need to review or verify the services connected to an automation action, but it won’t provide details about the action itself or modify any existing configurations.
Retrieves detailed information about a specific addon installed on a pagerduty account. this endpoint allows users to fetch the current configuration, status, and other relevant details of an addon without modifying it. it’s particularly useful for auditing installed addons, troubleshooting integration issues, or gathering information before making changes to an addon’s setup. the endpoint returns a comprehensive view of the addon, which may include its type, version, configuration parameters, and current operational status. use this endpoint when you need to inspect or verify the details of a particular addon in your pagerduty environment.
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.
Retrieves detailed information about a specific incident in pagerduty using its unique identifier. this endpoint allows users to access comprehensive data about an individual incident, including its current status, assigned responders, and related metadata. it is particularly useful for tracking the progress of an ongoing incident, reviewing historical incident data, or integrating incident details into external systems or reports. the endpoint should be used when specific incident information is needed, rather than for retrieving bulk or summarized incident data. note that this endpoint provides a snapshot of the incident at the time of the request and may not reflect real-time updates without subsequent api calls.
Retrieves the service dependencies for a specific business service in pagerduty. this endpoint allows you to fetch a list of services that are dependent on or related to the specified business service, helping to understand the interconnections within your incident management structure. use this when you need to analyze the impact of incidents on critical business functions or when planning incident response strategies. the endpoint provides a snapshot of the current dependency structure and does not include historical data or future planned changes to service relationships.
Retrieves a list of all extensions associated with the authenticated pagerduty account. extensions are additional features or integrations that enhance pagerduty’s functionality, such as custom notification methods or third-party service connections. this endpoint is useful for auditing the extensions currently in use, planning integration strategies, or managing the account’s extension ecosystem. it provides a comprehensive overview of all extensions without the need for specific query parameters. however, it does not allow for filtering or sorting of the results, so all data processing must be done client-side.
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.
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.
Retrieves information about how a specific automation action is associated with a particular service in pagerduty. this endpoint allows users to query the relationship between an automation action and a service, providing details on how the action is configured or applied within the context of the specified service. it’s useful for understanding the automation setup for incident management and response processes for a given service. the endpoint requires both the automation action id and the service id to fetch the relevant association details.
Retrieves the custom field values associated with a specific incident in pagerduty. this endpoint allows users to access additional metadata that has been added to an incident, providing more context and enabling better incident management. it should be used when detailed information about an incident’s custom fields is needed, such as for reporting, analysis, or integration with other systems. the endpoint returns only the custom field values and does not modify the incident or its fields.
Retrieves a list of automation action invocations from the pagerduty incident management platform. this endpoint allows users to query and review the history of automated actions that have been executed within their pagerduty environment. it can be used to audit automation processes, track the frequency and timing of automated responses, and analyze the effectiveness of incident management workflows. the endpoint is particularly useful for administrators and devops teams who need to monitor and optimize their automated incident response strategies. note that while this endpoint provides historical data, it does not trigger new automated actions or modify existing ones.
Retrieves the active event orchestration configuration for a specific pagerduty service. this endpoint allows you to fetch the current rules and settings that determine how incidents are created and routed for the specified service. use this when you need to review or audit the active event handling setup for a particular service. it’s particularly useful for understanding how incoming events are being processed and managed within your pagerduty environment. this endpoint focuses solely on the active configuration and does not provide historical data or allow modifications to the orchestration rules.
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.
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.
Retrieves a list of past incidents related to a specific incident in pagerduty. this endpoint allows users to explore the historical context of an incident by fetching previous occurrences or related issues. it’s particularly useful for identifying recurring problems, analyzing incident patterns, and improving overall incident management processes. the endpoint should be used when investigating the root cause of an incident or when compiling reports on incident history. note that this endpoint focuses on historical data and does not provide real-time incident information or updates to the current incident status.
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.
Retrieves detailed information about a specific log entry in the pagerduty system. this endpoint is used to access the complete record of an event or action that occurred within pagerduty, such as incident updates, user actions, or system changes. it’s particularly useful for auditing purposes, investigating specific actions taken during incident management, or gathering detailed information about system activities. the endpoint returns a single log entry based on the provided id, allowing for precise tracking and analysis of individual events within the incident management lifecycle. note that this endpoint is not designed for real-time monitoring or bulk log retrieval; it’s intended for accessing specific, historical log entries when detailed information about a particular event is required.
Retrieves detailed information about a specific integration associated with a particular service in pagerduty. this endpoint allows you to fetch the configuration and status of an integration, which can be crucial for understanding how external systems or tools are connected to your pagerduty service. use this when you need to review or troubleshoot a specific integration’s settings within the context of a service. it’s particularly useful for auditing your integrations or preparing for updates to your incident management workflow. note that this endpoint only provides read access to integration details and cannot be used to modify the integration.
Retrieves detailed information about a specific response play in the pagerduty incident management system. this endpoint allows users to access the configuration and actions associated with a predefined response play, which is used to automate and streamline incident response processes. it’s particularly useful when you need to review or audit the steps in a response play, or when preparing to update an existing response play. the endpoint returns comprehensive data about the response play, including its name, description, and the sequence of actions it performs during an incident.
Retrieves the current on-call information for your pagerduty account. this endpoint provides a comprehensive view of who is currently on-call across various schedules and escalation policies. it’s particularly useful for getting an overview of your organization’s current on-call status, identifying who is responsible for incident response at any given time, and planning team availability. the endpoint supports filtering by users, escalation policies, and schedules, making it versatile for different querying needs. it also allows for pagination and including additional details like contact methods and schedule information. this tool should be used when you need to quickly assess the current on-call situation or gather data for on-call analytics. note that while it provides current and near-future on-call information, it may not be suitable for long-term scheduling or historical analysis beyond a 3-month window.
Retrieves detailed information about a specific ruleset in pagerduty using its unique identifier. this endpoint allows you to fetch the complete configuration and settings of a single ruleset, which is essential for understanding how incident responses are automated and managed. use this when you need to review, audit, or troubleshoot a particular ruleset’s configuration. the response will include all relevant details such as the ruleset’s name, type, routing keys, and associated rules. it’s particularly useful when you need to examine the exact setup of a ruleset without making any changes. note that this endpoint only provides read access and cannot be used to modify the ruleset.
Retrieves detailed information about a specific on-call handoff notification rule for a given user in pagerduty. this endpoint is crucial for managing and reviewing the notification settings that govern how users are alerted during on-call responsibility transitions. it provides access to the configuration of rules that determine when and how a user is notified about upcoming on-call shifts or handoffs. this tool should be used when there’s a need to inspect or audit the notification preferences for on-call transitions of a particular user. it’s particularly useful for team leads or administrators who need to ensure smooth handoffs between team members during critical incident management periods.
Retrieves detailed information about a specific change event in pagerduty using its unique identifier. this endpoint is crucial for tracking and auditing changes within your incident management workflow. it provides comprehensive data about a single change event, which may include the type of change, when it occurred, who initiated it, and its impact on related incidents or services. use this endpoint when you need to investigate the details of a particular change, such as during incident postmortems or when analyzing the effectiveness of change management processes. the endpoint is particularly useful for understanding the context and timeline of changes that may have affected your systems or services.
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.
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.
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.
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.
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.
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.
Retrieves a list of services associated with a specific status page in pagerduty. this endpoint is used to fetch detailed information about the services that are being monitored and displayed on a particular status page. it’s particularly useful when you need to review or update the services shown on a status page, or when integrating status page information with other systems. the endpoint returns service details such as names, current statuses, and any relevant metadata, allowing for comprehensive monitoring and management of services within the context of a status page.
Retrieves a list of services configured in the pagerduty account. this endpoint allows you to fetch details about various services set up for incident management and alerting. it’s particularly useful for getting an overview of all services, their configurations, and associated teams or escalation policies. the endpoint supports filtering, sorting, and pagination to manage large sets of services efficiently. use this when you need to audit existing services, prepare for bulk updates, or integrate service information into other systems. note that the response may not include full details of each service, and separate api calls might be necessary to fetch comprehensive information for individual services.
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.
Retrieves the list of overrides for a specific schedule in pagerduty. this endpoint allows users to fetch temporary modifications to the regular on-call rotation, providing insight into any manual adjustments made to the schedule. it’s particularly useful for auditing changes, understanding the current state of a schedule, or verifying that overrides have been correctly applied. the endpoint should be used when there’s a need to review or analyze schedule modifications, especially in cases of incident management or when planning future on-call rotations. note that this endpoint only provides information about existing overrides and does not allow for creating, modifying, or deleting overrides.
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.
Retrieves a list of status dashboards and their associated information from the pagerduty system. this endpoint provides a comprehensive overview of the current operational status, performance metrics, and health indicators across various systems or services monitored by pagerduty. it’s particularly useful for obtaining a high-level view of system status without diving into specific incidents or alerts. the endpoint should be used when you need to quickly assess the overall health of your monitored systems, identify any ongoing issues or incidents, and get a snapshot of key performance indicators. it’s ideal for regular system checks, creating status pages, or integrating system health information into other monitoring tools. while this endpoint offers a broad view of system status, it may not provide detailed information about specific incidents or historical data. for in-depth analysis of particular issues or long-term trends, you may need to use other specialized endpoints.
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.
Retrieves the alert grouping settings for a specific configuration identified by its unique id in pagerduty. this endpoint allows users to access detailed information about how alerts are grouped for a particular service or team. it’s useful for reviewing current grouping rules, understanding the logic behind incident correlation, and auditing alert management configurations. the endpoint should be used when you need to examine or verify the existing alert grouping settings, which can be crucial for optimizing incident response and reducing alert fatigue. it does not modify any settings and is intended for read-only operations.
Retrieves the standards scores for a specific resource in pagerduty. this endpoint allows users to fetch performance or compliance metrics for a given resource type (such as incidents, services, or teams) identified by its unique id. the scores provide insights into how well the resource is meeting predefined standards or best practices within the pagerduty platform. this tool is particularly useful for assessing the effectiveness of incident management processes, service performance, or team efficiency. it should be used when seeking to evaluate or benchmark the performance of specific pagerduty resources against established standards. note that the exact scoring criteria and scale may vary depending on the resource type and pagerduty’s current scoring methodology.
Retrieves detailed information about a specific service associated with a particular status page in pagerduty. this endpoint is used to fetch the current status, configuration, and other relevant details of a service displayed on a status page. it’s particularly useful for monitoring the health and state of individual components within a larger system. the endpoint should be used when you need up-to-date information about a specific service’s status or when integrating pagerduty’s status information into other monitoring or reporting tools. note that this endpoint only provides information for services that are configured to be displayed on the specified status page.
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.
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.
Retrieves detailed information about a specific team in pagerduty based on the provided team id. this endpoint allows users to fetch comprehensive data about a team, including its members, roles, and configurations. it is particularly useful for applications that need to display or process team information, such as team management dashboards or reporting tools. the endpoint returns all available details about the specified team, providing a snapshot of its current state within the pagerduty system.
Retrieves a list of rulesets from the pagerduty system. rulesets are collections of event rules that define how incidents are managed and alerts are configured. this endpoint allows you to view all available rulesets, which is crucial for understanding your incident management setup and making informed decisions about alert routing and event handling. use this endpoint when you need to audit your ruleset configurations, prepare for modifications to your incident management workflow, or simply need an overview of your current ruleset structure. the response will include details about each ruleset, such as its name, id, and potentially its associated rules, depending on the api version and configuration. this endpoint supports pagination to handle large numbers of rulesets efficiently.
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.
The listteams endpoint retrieves a list of teams within a pagerduty account. it provides an overview of all teams or a filtered subset based on the optional query parameter. this endpoint is useful for obtaining team information, such as team names and ids, which can be used in other api calls or for organizational purposes. the response typically includes basic details about each team, allowing for further actions or more detailed queries on specific teams. use this endpoint when you need to survey the teams in your pagerduty organization, prepare for team management tasks, or integrate team information into other systems. note that while it returns a list of teams, it may not provide exhaustive details for each team; for comprehensive information on a specific team, a separate api call might be necessary.
Retrieves detailed information about a specific tag in the pagerduty system using its unique identifier. this endpoint allows users to fetch the properties and metadata associated with a particular tag, which can be useful for incident management, reporting, and organization within pagerduty. it should be used when detailed information about a specific tag is needed, such as its name, description, or any custom attributes. the endpoint will not modify or create tags; it is purely for retrieval of existing tag data. note that the response will only include information for tags that the authenticated user has permission to view.
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.
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.
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.
Retrieves the current statuses for a specified pagerduty status page. this endpoint allows users to fetch real-time status information for a given status page, providing up-to-date details on service availability and any ongoing issues. it’s particularly useful for monitoring the current state of services, especially during incident management processes. the endpoint should be used when there’s a need to programmatically access the latest status information for a specific status page, enabling integration with other systems or dashboards for enhanced visibility of service health.
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.
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.
Retrieves change events associated with a specific pagerduty service. this endpoint allows you to fetch informational updates about recent changes such as code deploys, system configuration modifications, and other significant alterations related to the specified service. it’s particularly useful for tracking and auditing changes that might impact service performance or reliability. the endpoint should be used when you need to review the history of changes for a service, investigate potential causes of incidents, or maintain a log of service modifications for compliance purposes. note that this endpoint focuses solely on change events and does not provide real-time incident data or service configuration details.
Retrieves detailed information about a specific team associated with an automation actions runner in pagerduty. this endpoint is used to get insights into the relationship between a runner and a particular team, which is crucial for understanding access permissions and management of automation tasks. it should be used when you need to confirm team associations, verify permissions, or gather team-specific details related to a runner. the endpoint does not modify any data and is primarily for information retrieval purposes. note that this endpoint focuses on a single team-runner relationship and does not provide a comprehensive list of all teams associated with a runner or vice versa.
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.
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.
Retrieves detailed information about a specific user in the pagerduty platform using their unique identifier. this endpoint is used to fetch user account details, such as contact information, role assignments, and notification rules. it’s particularly useful when you need to access or verify a user’s current information within your incident management workflow. the endpoint returns a comprehensive user profile, but it does not provide information about the user’s current on-call status or incident history.
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.
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.
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.
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.
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.
Retrieves all rules associated with a specific pagerduty service. this endpoint allows users to fetch the set of rules that define when and how incidents are triggered for a particular service. it’s essential for understanding the current automation and alert routing setup for a given service. use this endpoint when you need to audit, review, or programmatically access the rule configurations for a service. the endpoint returns rule details but does not provide information about ongoing incidents or service status. it’s particularly useful for integrations that need to sync or analyze rule configurations across multiple services or external systems.
Retrieves the notification rules for a specific user in pagerduty. this endpoint allows you to fetch all configured notification rules associated with a given user, providing insight into how and when the user receives alerts for incidents. it’s particularly useful for auditing a user’s notification setup, troubleshooting notification issues, or programmatically managing user preferences. the endpoint returns a list of notification rules, likely including details such as contact methods, time-based restrictions, and urgency levels for each rule. it should be used when you need to review or analyze a user’s current notification configuration within your incident management workflow.
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.
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.
Retrieves all notes associated with a specific incident in pagerduty. this endpoint allows users to access the complete history of comments, updates, and additional information added to an incident throughout its lifecycle. it is particularly useful for reviewing the incident’s progress, understanding the actions taken, and gathering context for post-incident analysis. the endpoint should be used when detailed information about an incident’s communication trail is needed, such as during incident reviews or when compiling reports. it does not provide real-time updates and may not include the most recent notes if called immediately after a new note is added due to potential api caching.
Retrieves the service impacts associated with a specific status dashboard in pagerduty. this endpoint allows users to fetch detailed information about how incidents are affecting various services within the context of a particular status dashboard. it should be used when there’s a need to assess the current operational status and impact of incidents on services for a given dashboard. the endpoint provides real-time insights into service disruptions, helping teams quickly identify and prioritize issues. note that this endpoint only returns data for a single status dashboard at a time and does not provide historical impact data.
This endpoint allows you to subscribe users or teams to a specific business service in pagerduty. it enables you to add multiple subscribers in a single request, streamlining the process of setting up notification recipients for critical incidents. use this endpoint when you need to configure who receives alerts and updates for a particular business service. the endpoint is particularly useful for initial setup or bulk updates to subscriber lists. note that this operation adds new subscribers but does not remove existing ones; to remove subscribers, you would need to use a separate endpoint.
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.
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.
Retrieves a list of all rules associated with a specific ruleset in pagerduty. this endpoint is used to examine the configuration of event routing within a particular ruleset, allowing users to review and understand how incoming events are processed and handled. it’s particularly useful for auditing, troubleshooting, or preparing to modify event handling logic. the endpoint returns details about each rule, likely including conditions, actions, and priorities, providing a comprehensive view of the ruleset’s behavior. while it doesn’t modify any data, it’s an essential tool for managing and maintaining effective incident response workflows in pagerduty.
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.
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.
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.
Unsubscribes a team from notifications for specific incidents or business services in pagerduty. this endpoint is used to stop a team from receiving alerts and updates about particular entities. it’s particularly useful for managing notification overload or when a team is no longer responsible for certain incidents or services. the endpoint requires a list of subscribables (entities to unsubscribe from), each identified by a unique id and type. at least one subscribable must be provided, and all items in the list must be unique. this operation cannot be undone through this endpoint, so use it cautiously.
Retrieves the available fields for pagerduty templates. this endpoint provides a comprehensive list of all possible fields that can be used when creating or modifying templates within the pagerduty platform. it is particularly useful for developers and administrators who need to understand the structure and available options for template customization. the endpoint should be used when building interfaces for template management, automating template creation, or gathering information about the configurable aspects of pagerduty templates. it does not modify any existing templates or create new ones; it only provides information about the available fields.
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.
This endpoint allows you to update an existing automation action runner in pagerduty. it is used to modify the properties of a runner, such as its name, description, and, for runbook runners, the runbook server connection details. the endpoint supports updating both sidecar and runbook type runners, distinguished by the ‘runner type’ discriminator. use this endpoint when you need to change the configuration of an existing runner, such as updating its name for better identification or modifying the runbook server details. note that while you can update most properties, you cannot change a runner’s type (e.g., from sidecar to runbook) using this endpoint.
Update an incident type. incident types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. <!— theme: warning —> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. for more information see the api concepts document scoped oauth requires: incident types.write
This endpoint allows you to send responder requests for a specific incident in pagerduty. it is used to request additional help or notify specific users or escalation policies about an ongoing incident that requires attention. the endpoint creates a new responder request associated with the incident identified by the {id} path parameter. it’s particularly useful when you need to quickly engage additional resources or escalate an incident to ensure timely resolution. this tool should be used when there’s a need to bring in more responders or escalate an incident beyond its current assigned team. it’s important to note that this endpoint doesn’t resolve the incident itself but facilitates the process of engaging additional help.
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.
Retrieves detailed information about a specific vendor integrated with pagerduty. this endpoint allows users to access comprehensive data about a vendor, including its name, type of integration, capabilities, and current status within the pagerduty ecosystem. it’s particularly useful when you need to verify vendor details, check integration status, or gather information for reporting and auditing purposes. the endpoint returns a single vendor object and should be used when specific vendor information is required, rather than for listing multiple vendors.
Retrieves the list of severities associated with a specific status page in pagerduty. this endpoint allows users to fetch the current severity levels configured for a particular status page, which is crucial for understanding the criticality of incidents or service statuses displayed on that page. it should be used when there’s a need to programmatically access or display the severity information for a given status page, such as in monitoring dashboards or integrated incident management systems. the endpoint provides only the severity data and does not modify any existing configurations.
Update a field option for a custom field. <!— theme: warning —> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: custom fields.write
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.
Retrieves a list of users associated with a specific pagerduty schedule. this endpoint is essential for managing on-call rotations and understanding who is responsible for incident response during different time periods. it should be used when you need to view all users assigned to a particular schedule, which is helpful for auditing, planning, or modifying on-call arrangements. the endpoint returns basic user information and does not provide detailed schedule timeslots or user availability. it’s particularly useful for larger teams with complex rotation schedules to ensure proper coverage and fair distribution of on-call responsibilities.
Updates the status of a specific alert within an incident in pagerduty. this endpoint allows you to modify an alert’s status, primarily to mark it as resolved. it’s crucial for managing the lifecycle of alerts and incidents in pagerduty’s incident management system. use this when you need to programmatically update the state of an alert, typically as part of an automated incident resolution process or when integrating external systems with pagerduty. note that while the endpoint accepts various fields in the request body, most are read-only, with the ‘status’ field being the primary modifiable attribute.
Updates an existing add-on in pagerduty with new properties. this endpoint allows you to modify the type, name, and source url of a specific add-on identified by its unique id. it’s used when you need to change the configuration or appearance of an add-on that’s already integrated into your pagerduty instance. the endpoint updates only the mutable fields and returns the full updated add-on object, including read-only fields. note that this operation cannot modify the add-on’s id or other system-generated fields like ‘summary’, ‘self’, or ‘html url’.
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. <!— theme: warning —> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: custom fields.write
Creates notification subscriptions for a specific user in pagerduty. this endpoint allows you to subscribe a user to multiple incidents or business services in a single api call. it’s particularly useful for setting up customized notification preferences for users, ensuring they receive alerts for specific entities they need to monitor. the endpoint supports bulk subscription, allowing you to subscribe a user to multiple entities simultaneously, improving efficiency in managing user notifications. note that this endpoint only creates subscriptions and does not modify or delete existing ones.
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.
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.
Retrieves a list of users from the pagerduty system. this endpoint allows you to fetch information about multiple users in your pagerduty account, which can be useful for user management, generating reports, or integrating user data with other systems. the response typically includes basic information about each user, such as their id, name, email, and role. use query parameters to filter, paginate, or search for specific users. this endpoint is ideal for bulk operations or when you need an overview of your pagerduty user base. note that the results may be paginated, so multiple calls might be necessary to retrieve all users for large accounts.
Retrieves a list of all tags currently used within the pagerduty account. this endpoint provides a comprehensive view of the tags used for categorization and labeling of incidents across the system. it should be used when you need an overview of all available tags for incident management, reporting, or when setting up new incident routing rules. the endpoint returns all tags without any filtering, which may result in a large dataset for accounts with extensive tag usage. it does not provide information about which incidents or entities are associated with each tag.
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.
Updates the channel information for a specific log entry in pagerduty. this endpoint allows you to modify the details of how notifications are delivered for a particular log entry, while maintaining the original channel type. it’s useful for refining or correcting the notification settings of an existing log entry. the endpoint requires the log entry id in the url path and accepts a json payload with updated channel information. note that while you can update the channel details, you cannot change the channel type, which must match the existing value.
Updates an existing change event in pagerduty. this endpoint allows you to modify certain attributes of a change event, such as its summary or custom details. it’s used when you need to amend or add information to a previously created change event, perhaps due to new developments or corrections. the endpoint requires the change event’s unique id and accepts an object with the fields to be updated. note that many fields (e.g., timestamp, services, integration) are read-only and cannot be modified through this endpoint. use this when you need to refine or expand upon the information in an existing change event, but be aware of its limitations in terms of which fields can be updated.
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.
The updateincident endpoint allows you to modify various attributes of an existing incident in pagerduty’s incident management system. this put operation enables users to update incident status, priority, assignments, escalation levels, and other key properties. it’s particularly useful for reflecting the current state of an incident, reassigning responsibilities, or adjusting the incident’s urgency and escalation path. the endpoint should be used when there are significant changes to an incident that need to be reflected in the system, such as acknowledging the incident, marking it as resolved, or changing its priority. it’s important to note that this endpoint updates an existing incident and does not create new incidents. care should be taken when modifying critical fields like status or escalation policy, as these changes can significantly impact the incident management workflow.
This endpoint allows you to update an existing event rule within a specified ruleset in pagerduty. event rules define conditions for matching events and actions to take when those conditions are met. you can modify various aspects of the rule, including its active status, matching conditions, time frames, variables, position in the ruleset, and associated actions. this endpoint is particularly useful for fine-tuning your incident management workflow, adjusting how events are processed, and controlling alert behavior. it’s important to note that changes made through this endpoint will immediately affect how incoming events are handled, so careful consideration should be given to the potential impact on your alerting system.
Updates an existing extension in pagerduty. this endpoint allows you to modify the configuration of a previously created extension, such as a webhook or custom integration. you can update properties like the extension’s name, endpoint url, associated objects, and custom configuration. this is useful for maintaining and adjusting integrations as your operational needs change. the endpoint requires the extension’s id in the url path and accepts a json payload with the updated extension details. it’s important to note that some fields, like the extension’s id and type, are read-only and cannot be modified through this endpoint.
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.
This endpoint updates an existing on-call handoff notification rule for a specific user in pagerduty. it allows you to modify the notification delay, handoff type, and contact method for the rule. use this endpoint when you need to change how and when a user is notified about upcoming on-call shifts or when they are going off-call. the endpoint requires both the user id and the specific rule id in the url path. you can update the notification delay (in minutes), the type of handoff (both, oncall, or offcall), and the preferred contact method for the notification. this endpoint is particularly useful for adjusting notification preferences as team structures or individual availability changes.
Update an existing incident workflow trigger scoped oauth requires: incident workflows.write
Updates an existing maintenance window in pagerduty’s incident management system. this endpoint allows you to modify the details of a scheduled maintenance period, including its start and end times, affected services, and description. it’s used to adjust planned maintenance activities, ensuring that incidents are not created for specified services during the defined timeframe. the endpoint requires the maintenance window’s unique id and accepts a json object with the updated information. it’s particularly useful for extending or shortening maintenance periods, changing the list of affected services, or updating the window’s description in response to changing maintenance requirements.
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.
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.
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.
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.
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.
Updates an existing escalation policy in pagerduty with new settings and rules. this endpoint allows you to modify various aspects of an escalation policy, including its name, description, escalation rules, associated services, and team. it’s used when you need to change how incidents are escalated and handled within your organization. the updated policy details are provided in the request body, and the policy to be updated is identified by its id in the url path. this tool is essential for maintaining and adjusting incident response workflows in pagerduty to ensure optimal team responsiveness and incident management.
Updates or creates a postmortem for a specific post on a pagerduty status page. this endpoint allows users to add detailed analysis and insights about an incident after its resolution. it’s primarily used for communicating the cause, impact, and lessons learned from an incident to stakeholders and subscribers. the postmortem can include rich text content for comprehensive explanations. users can control whether subscribers are notified about the postmortem update, making it flexible for both major updates and minor edits. this endpoint is crucial for maintaining transparency and improving incident management processes.
Update an existing workflow integration connection. scoped oauth requires: workflow integrations:connections.write
Updates an existing event orchestration in pagerduty. this endpoint allows you to modify the name, description, and team ownership of a specific orchestration identified by its id. it’s used to refine and adjust your incident management workflow by updating the configuration of how events are processed and routed. this tool is particularly useful when you need to change the purpose, ownership, or details of an orchestration without creating a new one. note that certain properties like integrations, routing information, and timestamps are read-only and cannot be modified through this endpoint. use this when you need to update an orchestration’s metadata or reassign it to a different team.
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.
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.
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.
Updates the configuration of an existing event orchestration router in pagerduty. this endpoint allows you to modify the rules and routing logic for incoming events, determining how they are directed to specific services. it’s used to refine and adjust your incident management workflow by updating conditions, actions, and catch-all behavior for event routing. the update is comprehensive, meaning any omitted rules or details will be deleted from the existing configuration. use this endpoint when you need to make changes to your event routing strategy or when adding new services or conditions to your orchestration setup.
This endpoint updates an existing incident workflow in pagerduty by its unique identifier. it allows you to modify various aspects of the workflow, including its name, description, associated team, and the sequence of steps to be executed during an incident. the primary use case is to refine or adjust incident response processes by altering the workflow’s configuration. this is particularly useful when incident management practices need to be updated based on new requirements or lessons learned from previous incidents. the endpoint provides granular control over each step in the workflow, allowing for precise tuning of automated actions and their inputs. however, it’s important to note that modifying a workflow may impact ongoing or future incident responses, so changes should be made thoughtfully and tested thoroughly before implementation in a production environment.
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.
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.
The updateschedule endpoint modifies an existing on-call schedule in pagerduty. it updates the schedule’s name, time zone, description, and layers. each layer defines a rotation pattern for on-call duties. use this to adjust rotations, add/remove users, change time zones, or modify restrictions. note: this replaces the entire schedule configuration, so include all desired layers and settings, even if only changing part of the schedule.
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.
This endpoint updates the active status of a specific service orchestration in pagerduty. it allows you to activate or deactivate a service orchestration by setting its ‘active’ status. use this endpoint when you need to change the operational state of a service orchestration, such as during maintenance periods or when adjusting your incident management workflow. the endpoint requires the service id in the url path and accepts a json body with the ‘active’ boolean parameter. it’s important to note that changing the active status may affect how incidents are routed and managed for the associated service, so use this endpoint judiciously and in accordance with your organization’s incident management policies.
Updates an existing standard in the pagerduty incident management platform. this endpoint allows you to modify various attributes of a standard, including its active status, filtering criteria, description, and the technical services it applies to. use this when you need to adjust the scope or behavior of an existing standard, such as enabling or disabling it, refining its application using regex patterns, or updating the list of included or excluded services. the changes made through this endpoint will affect how the standard is applied to your incident management processes, potentially impacting alerting and response workflows for the associated services.
Updates the role of a specific user within a pagerduty team. this endpoint allows you to modify a user’s permissions and responsibilities by changing their role in the team structure. use this when you need to promote, demote, or adjust a team member’s access level. the new role affects the user’s ability to view, respond to, or manage incidents within the team context. note that this operation only changes the user’s role for the specified team and does not affect their roles in other teams or their global account permissions.
Updates an existing post update on a pagerduty status page. this endpoint allows you to modify the details of a specific post update, including its message, status, severity, impacted services, and notification settings. use this when you need to provide new information about an ongoing incident, change the status or severity of an issue, or update the list of affected services. it’s particularly useful for keeping your audience informed about the progress of incident resolution or service status changes. the endpoint requires a comprehensive ‘post update’ object that encapsulates all the update details, ensuring that all necessary information is provided in a structured manner.
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.
Updates the unrouted orchestration rules for a specific event orchestration in pagerduty. this endpoint allows you to define how events that don’t match any service-specific rules should be handled. it’s used to create a fallback mechanism for event routing and manipulation, ensuring that all incoming events are processed appropriately. the update is comprehensive, meaning any omitted rules or rule details from the request will be deleted from the existing configuration. use this endpoint when you need to modify the global handling of unrouted events, such as changing default severities, updating event summaries, or implementing new routing logic for unmatched events.
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.
Update 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.write
Updates a specific status update notification rule for a pagerduty user. this endpoint allows you to modify how a user receives notifications about incident status changes. it’s used to change the contact method (e.g., email, phone, push notification, or sms) for a particular notification rule. this is useful for adjusting user preferences or updating contact information. the endpoint requires the user’s id and the specific notification rule id in the url path, ensuring precise updates to the intended rule.
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.
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.
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.
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