Skip to content
Changelog

Report a bug

PagerDuty integration: operations for AI agents

PagerDuty connects to Type.com as an integration. This page lists the 475 operations documented for Claude and Codex in Type.com: 232 read, 86 write, 157 destructive.

About PagerDuty

PagerDuty helps you proactively manage your digital operations by collecting data signals from anywhere, interpreting those signals using machine learning, automatically engaging the right people, and accelerating resolution and learning.

Categories: Developer Tools & IT

How to connect PagerDuty to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

475 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

475 operations listed.

Tags

  • Read

    Get tags for entities

    Get related tags for Users, Teams or Escalation Policies. A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#tags) Scoped OAuth requires: `tags.read`

    GET /{entity_type}/{id}/tags

  • Read

    List tags

    List all of your account's tags. A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#tags) Scoped OAuth requires: `tags.read`

    GET /tags

  • Read

    Get a tag

    Get details about an existing Tag. A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#tags) Scoped OAuth requires: `tags.read`

    GET /tags/{id}

  • Read

    Get connected entities

    Get related Users, Teams or Escalation Policies for the Tag. A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#tags) Scoped OAuth requires: `tags.read`

    GET /tags/{id}/{entity_type}

  • Write

    Create a tag

    Create a Tag. A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#tags) Scoped OAuth requires: `tags.write`

    POST /tags

  • Destructive

    Assign tags

    Assign existing or new tags. A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#tags) Scoped OAuth requires: `tags.write`

    POST /{entity_type}/{id}/change_tags

  • Destructive

    Delete a tag

    Remove an existing Tag. A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#tags) Scoped OAuth requires: `tags.write`

    DELETE /tags/{id}

Abilities

  • Read

    List abilities

    List all of your account's abilities, by name. "Abilities" describes your account's capabilities by feature name. For example `"teams"`. An ability may be available to your account based on things like your pricing plan or account state. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#abilities) Scoped OAuth requires: `abilities.read`

    GET /abilities

  • Read

    Test an ability

    Test whether your account has a given ability. "Abilities" describes your account's capabilities by feature name. For example `"teams"`. An ability may be available to your account based on things like your pricing plan or account state. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#abilities) Scoped OAuth requires: `abilities.read`

    GET /abilities/{id}

Add ons

  • Read

    List installed Add-ons

    List all of the Add-ons installed on your account. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#add-ons) Scoped OAuth requires: `addons.read`

    GET /addons

  • Read

    Get an Add-on

    Get details about an existing Add-on. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#add-ons) Scoped OAuth requires: `addons.read`

    GET /addons/{id}

  • Write

    Install an Add-on

    Install an Add-on for your account. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. Given a configuration containing a `src` parameter, that URL will be embedded in an `iframe` on a page that's available to users from a drop-down menu. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#add-ons) Scoped OAuth requires: `addons.write`

    POST /addons

  • Destructive

    Delete an Add-on

    Remove an existing Add-on. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#add-ons) Scoped OAuth requires: `addons.write`

    DELETE /addons/{id}

  • Destructive

    Update an Add-on

    Update an existing Add-on. Addon's are pieces of functionality that developers can write to insert new functionality into PagerDuty's UI. Given a configuration containing a `src` parameter, that URL will be embedded in an `iframe` on a page that's available to users from a drop-down menu. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#add-ons) Scoped OAuth requires: `addons.write`

    PUT /addons/{id}

Alert Grouping Settings

  • Read

    List alert grouping settings

    List all of your alert grouping settings including both single service settings and global content based settings. The settings part of Alert Grouper service allows us to create Alert Grouping Settings and configs that are required to be used during grouping of the alerts. Scoped OAuth requires: `services.read`

    GET /alert_grouping_settings

  • Read

    Get an Alert Grouping Setting

    Get an existing Alert Grouping Setting. The settings part of Alert Grouper service allows us to create Alert Grouping Settings and configs that are required to be used during grouping of the alerts. Scoped OAuth requires: `services.read`

    GET /alert_grouping_settings/{id}

  • Write

    Create an Alert Grouping Setting

    Create a new Alert Grouping Setting. The settings part of Alert Grouper service allows us to create Alert Grouping Settings and configs that are required to be used during grouping of the alerts. This endpoint will be used to create an instance of AlertGroupingSettings for either one service or many services that are in the alert group setting. Scoped OAuth requires: `services.write`

    POST /alert_grouping_settings

  • Destructive

    Delete an Alert Grouping Setting

    Delete an existing Alert Grouping Setting. The settings part of Alert Grouper service allows us to create Alert Grouping Settings and configs that are required to be used during grouping of the alerts. Scoped OAuth requires: `services.write`

    DELETE /alert_grouping_settings/{id}

  • Destructive

    Update an Alert Grouping Setting

    Update an Alert Grouping Setting. The settings part of Alert Grouper service allows us to create Alert Grouping Settings and configs that are required to be used during grouping of the alerts. if `services` are not provided in the request, then the existing services will not be removed from the setting. Scoped OAuth requires: `services.write`

    PUT /alert_grouping_settings/{id}

Analytics

  • Read

    Get aggregated incident data

    Provides aggregated enriched metrics for incidents. The provided metrics are aggregated by day, week, month using the aggregate_unit parameter, or for the entire period if no aggregate_unit is provided. <!-- theme: info --> > A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement. <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.write`

    POST /analytics/metrics/incidents/all

  • Read

    Get aggregated escalation policy data

    Provides aggregated metrics for incidents aggregated into units of time by escalation policy. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#escalation-policy-list). <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.write`

    POST /analytics/metrics/incidents/escalation_policies

  • Read

    Get aggregated metrics for all escalation policies

    Provides aggregated metrics across all escalation policies. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#escalation-policy-list). <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.write`

    POST /analytics/metrics/incidents/escalation_policies/all

  • Read

    Get aggregated service data

    Provides aggregated metrics for incidents aggregated into units of time by service. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#services-list). Data can be aggregated by day, week or month in addition to by service, or provided just as a collection of aggregates for each service in the dataset for the entire period. If a unit is provided, each row in the returned dataset will include a 'range_start' timestamp. <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.write`

    POST /analytics/metrics/incidents/services

  • Read

    Get aggregated metrics for all services

    Provides aggregated metrics across all services. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#services-list). <!-- theme: info --> > A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement. <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.write`

    POST /analytics/metrics/incidents/services/all

  • Read

    Get aggregated team data

    Provides aggregated metrics for incidents aggregated into units of time by team. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#teams-list). Data can be aggregated by day, week or month in addition to by team, or provided just as a collection of aggregates for each team in the dataset for the entire period. If a unit is provided, each row in the returned dataset will include a 'range_start' timestamp. <!-- theme: info --> > A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement. <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.write`

    POST /analytics/metrics/incidents/teams

  • Read

    Get aggregated metrics for all teams

    Provides aggregated metrics across all teams. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#teams-list). <!-- theme: info --> > A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement. <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.write`

    POST /analytics/metrics/incidents/teams/all

  • Read

    Get aggregated PD Advance usage data

    Provides aggregated metrics for the usage of PD Advance. <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.write`

    POST /analytics/metrics/pd_advance_usage/features

  • Read

    Get aggregated metrics for all responders

    Provides aggregated incident metrics for all selected responders. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#responders-list). <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.write`

    POST /analytics/metrics/responders/all

  • Read

    Get responder data aggregated by team

    Provides incident metrics aggregated by responder. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#responders-list). <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.write`

    POST /analytics/metrics/responders/teams

  • Read

    Get aggregated metrics for all users

    Provides aggregated metrics across all users within their account. This endpoint provides summary statistics about user activity and performance. <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.write`

    POST /analytics/metrics/users/all

  • Read

    Get raw data - multiple incidents

    Provides enriched incident data and metrics for multiple incidents. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#incidents-list). <!-- theme: info --> > A `team_ids` or `service_ids` filter is required for [user-level API keys](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or keys generated through an OAuth flow. Account-level API keys do not have this requirement. <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.write`

    POST /analytics/raw/incidents

  • Read

    Get raw data - single incident

    Provides enriched incident data and metrics for a single incident. Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#incidents-list). <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.read`

    GET /analytics/raw/incidents/{id}

  • Read

    Get raw responses from a single incident

    Provides enriched responder data for a single incident. Example metrics include Time to Respond, Responder Type, and Response Status. See metric definitions below. <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.read`

    GET /analytics/raw/incidents/{id}/responses

  • Read

    Get raw incidents for a single responder_id

    Provides enriched incident data and metrics for a specific responder. Example metrics include Mean Seconds to Resolve, Mean Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our [Knowledge Base](https://support.pagerduty.com/docs/insights#incidents-list). <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.write`

    POST /analytics/raw/responders/{responder_id}/incidents

  • Read

    Get raw user analytics data

    Allows users to retrieve a raw list of user analytics data within their account. This endpoint provides detailed data about user activity and account configuration. <!-- theme: info --> > **Note:** Data availability reflects [pipeline processing cycles](https://support.pagerduty.com/main/docs/insights#:~:text=Data%20Update%20Schedule) and is generally within 24 hours under normal conditions. Scoped OAuth requires: `analytics.write`

    POST /analytics/raw/users

Audit

  • Read

    List audit records

    List audit trail records matching provided query params or default criteria. The returned records are sorted by the `execution_time` from newest to oldest. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set. Only admins, account owners, or global API tokens on PagerDuty account [pricing plans](https://www.pagerduty.com/pricing) with the "Audit Trail" feature can access this endpoint. For other role based access to audit records by resource ID, see the resource's API documentation. For more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/). Scoped OAuth requires: `audit_records.read`

    GET /audit/records

Automation Actions

  • Read

    List Automation Actions

    Lists Automation Actions matching provided query params. The returned records are sorted by action name in alphabetical order. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.

    GET /automation_actions/actions

  • Read

    Get an Automation Action

    Get an Automation Action

    GET /automation_actions/actions/{id}

  • Read

    Get all service references associated with an Automation Action

    Gets all service references associated with an Automation Action

    GET /automation_actions/actions/{id}/services

  • Read

    Get the details of an Automation Action / service relation

    Gets the details of a Automation Action / service relation

    GET /automation_actions/actions/{id}/services/{service_id}

  • Read

    Get all team references associated with an Automation Action

    Gets all team references associated with an Automation Action

    GET /automation_actions/actions/{id}/teams

  • Read

    Get the details of an Automation Action / team relation

    Gets the details of an Automation Action / team relation

    GET /automation_actions/actions/{id}/teams/{team_id}

  • Read

    List Invocations

    List Invocations

    GET /automation_actions/invocations

  • Read

    Get an Invocation

    Get an Automation Action Invocation

    GET /automation_actions/invocations/{id}

  • Read

    List Automation Action runners

    Lists Automation Action runners matching provided query params. The returned records are sorted by runner name in alphabetical order. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.

    GET /automation_actions/runners

  • Read

    Get an Automation Action runner

    Get an Automation Action runner

    GET /automation_actions/runners/{id}

  • Read

    Get all team references associated with a runner

    Gets all team references associated with a runner

    GET /automation_actions/runners/{id}/teams

  • Read

    Get the details of a runner / team relation

    Gets the details of a runner / team relation

    GET /automation_actions/runners/{id}/teams/{team_id}

  • Write

    Create an Automation Action

    Create a Script, Process Automation, or Runbook Automation action

    POST /automation_actions/actions

  • Write

    Create an Invocation

    Invokes an Action

    POST /automation_actions/actions/{id}/invocations

  • Write

    Associate an Automation Action with a service

    Associate an Automation Action with a service

    POST /automation_actions/actions/{id}/services

  • Write

    Associate an Automation Action with a team

    Associate an Automation Action with a team

    POST /automation_actions/actions/{id}/teams

  • Write

    Create an Automation Action runner.

    Create a Process Automation or a Runbook Automation runner.

    POST /automation_actions/runners

  • Write

    Associate a runner with a team

    Associate a runner with a team

    POST /automation_actions/runners/{id}/teams

  • Destructive

    Delete an Automation Action

    Delete an Automation Action

    DELETE /automation_actions/actions/{id}

  • Destructive

    Update an Automation Action

    Updates an Automation Action

    PUT /automation_actions/actions/{id}

  • Destructive

    Disassociate an Automation Action from a service

    Disassociate an Automation Action from a service

    DELETE /automation_actions/actions/{id}/services/{service_id}

  • Destructive

    Disassociate an Automation Action from a team

    Disassociate an Automation Action from a team

    DELETE /automation_actions/actions/{id}/teams/{team_id}

  • Destructive

    Update an Automation Action runner

    Update an Automation Action runner

    PUT /automation_actions/runners/{id}

  • Destructive

    Delete an Automation Action runner

    Delete an Automation Action runner

    DELETE /automation_actions/runners/{id}

  • Destructive

    Disassociate a runner from a team

    Disassociates a runner from a team

    DELETE /automation_actions/runners/{id}/teams/{team_id}

Business Services

  • Read

    List Business Services

    List existing Business Services. Business services model capabilities that span multiple technical services and that may be owned by several different teams. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.read`

    GET /business_services

  • Read

    Get a Business Service

    Get details about an existing Business Service. Business services model capabilities that span multiple technical services and that may be owned by several different teams. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.read`

    GET /business_services/{id}

  • Read

    List Business Service Subscribers

    Retrieve a list of Notification Subscribers on the Business Service. <!-- theme: warning --> > Users must be added through `POST /business_services/{id}/subscribers` to be returned from this endpoint. Scoped OAuth requires: `subscribers.read`

    GET /business_services/{id}/subscribers

  • Read

    List the supporting Business Services for the given Business Service Id, sorted by impacted status.

    Retrieve of Business Services that support the given Business Service sorted by highest Impact with `status` included. This endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted up to the limit of 200. The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name. To get impact information about a specific set of Business Services, use the `ids[]` parameter on the `/business_services/impacts` endpoint. Scoped OAuth requires: `services.read`

    GET /business_services/{id}/supporting_services/impacts

  • Read

    List Impactors affecting Business Services

    Retrieve a list of Impactors for the top-level Business Services on the account. Impactors are currently limited to Incidents. This endpoint does not return an exhaustive list of Impactors but rather provides access to the highest priority Impactors for the Business Services in question up to the limit of 200. To get Impactors for a specific set of Business Services, use the `ids[]` parameter. The returned Impactors are sorted first by priority and secondarily by their creation date. Scoped OAuth requires: `services.read`

    GET /business_services/impactors

  • Read

    List Business Services sorted by impacted status

    Retrieve a list top-level Business Services sorted by highest Impact with `status` included. When called without the `ids[]` parameter, this endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted up to the limit of 200. The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name. To get impact information about a specific set of Business Services, use the `ids[]` parameter. Scoped OAuth requires: `services.read`

    GET /business_services/impacts

  • Read

    Get the global priority threshold for a Business Service to be considered impacted by an Incident

    Retrieves the priority threshold information for an account. Currently, there is a `global_threshold` that can be set for the account. Incidents that have a priority meeting or exceeding this threshold will be considered impacting on any Business Service that depends on the Service to which the Incident belongs. Scoped OAuth requires: `services.read`

    GET /business_services/priority_thresholds

  • Write

    Create a Business Service

    Create a new Business Service. Business services model capabilities that span multiple technical services and that may be owned by several different teams. There is a limit of 5,000 business services per account. If the limit is reached, the API will respond with an error. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.write`

    POST /business_services

  • Write

    Create Business Service Account Subscription

    Subscribe your Account to a Business Service. Scoped OAuth requires: `subscribers.write`

    POST /business_services/{id}/account_subscription

  • Write

    Create Business Service Subscribers

    Subscribe the given entities to the given Business Service. Scoped OAuth requires: `subscribers.write`

    POST /business_services/{id}/subscribers

  • Destructive

    Delete a Business Service

    Delete an existing Business Service. Once the service is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this service. Business services model capabilities that span multiple technical services and that may be owned by several different teams. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.write`

    DELETE /business_services/{id}

  • Destructive

    Update a Business Service

    Update an existing Business Service. NOTE that this endpoint also accepts the PATCH verb. Business services model capabilities that span multiple technical services and that may be owned by several different teams. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.write`

    PUT /business_services/{id}

  • Destructive

    Delete Business Service Account Subscription

    Unsubscribe your Account from a Business Service. Scoped OAuth requires: `subscribers.write`

    DELETE /business_services/{id}/account_subscription

  • Destructive

    Remove Business Service Subscribers

    Unsubscribes the matching Subscribers from a Business Service. Scoped OAuth requires: `subscribers.write`

    POST /business_services/{id}/unsubscribe

  • Destructive

    Deletes the account-level priority threshold for Business Service impact

    Clears the Priority Threshold for the account. If the priority threshold is cleared, any Incident with a Priority set will be able to impact Business Services. Scoped OAuth requires: `services.write`

    DELETE /business_services/priority_thresholds

  • Destructive

    Set the Account-level priority threshold for Business Service impact.

    Set the Account-level priority threshold for Business Service. Scoped OAuth requires: `services.write`

    PUT /business_services/priority_thresholds

Change Events

  • Read

    List Change Events

    List all of the existing Change Events. Scoped OAuth requires: `change_events.read`

    GET /change_events

  • Read

    Get a Change Event

    Get details about an existing Change Event. Scoped OAuth requires: `change_events.read`

    GET /change_events/{id}

  • Read

    List related Change Events for an Incident

    List related Change Events for an Incident, as well as the reason these changes are correlated with the incident. Change events represent service changes such as deploys, build completion, and configuration changes, providing information that is critical during incident triage or hypercare. For more information on change events, see [Change Events](https://support.pagerduty.com/docs/change-events). The Change Correlation feature provides incident responders with recent change events that are most relevant to that incident. Change Correlation informs the responder why a particular change event was surfaced and correlated to an incident based on three key factors which include time, related service, or intelligence (machine learning). Scoped OAuth requires: `incidents.read`

    GET /incidents/{id}/related_change_events

  • Read

    List Change Events for a service

    List all of the existing Change Events for a service. Scoped OAuth requires: `services.read`

    GET /services/{id}/change_events

  • Write

    Create a Change Event

    Sending Change Events is documented as part of the V2 Events API. See [`Send Change Event`](https://developer.pagerduty.com/api-reference/b3A6Mjc0ODI2Ng-send-change-events-to-the-pager-duty-events-api).

    POST /change_events

  • Destructive

    Update a Change Event

    Update an existing Change Event Scoped OAuth requires: `change_events.write`

    PUT /change_events/{id}

Enrichment Integrations

  • Read

    List ServiceNow integrations

    Lists the ServiceNow enrichment integrations for the account, including their CMDB tables, field mappings, and credentials. Because only one integration is allowed per account, this returns at most one integration. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.read`

    GET /enrichment/integrations/servicenow

  • Read

    Get a ServiceNow integration

    Retrieves a single ServiceNow enrichment integration by ID, including its CMDB tables, field mappings, the current sync status of each table, and credentials. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.read`

    GET /enrichment/integrations/servicenow/{integration_id}

  • Read

    Test a CMDB table

    Validates a ServiceNow CMDB table configuration by running a live query against ServiceNow and returning up to 10 sample records. Use this before enabling synchronization to confirm that the credentials, table name, query filter, and mapped fields are correct. Records are returned keyed by ServiceNow field name. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.read`

    GET /enrichment/integrations/servicenow/{integration_id}/tables/{table_id}/test

  • Read

    Get ServiceNow credentials

    Retrieves the ServiceNow credentials by ID. The password is never returned. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.read`

    GET /enrichment/integrations/servicenow/credentials/{credentials_id}

  • Write

    Create a ServiceNow integration

    Creates a ServiceNow enrichment integration with one or more CMDB table configurations. Only one integration is allowed per account. Each CMDB table must define between 2 and 20 field mappings, and an integration may contain at most 8 tables. Credentials are managed separately through the credentials endpoints. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.write`

    POST /enrichment/integrations/servicenow

  • Write

    Add a CMDB table

    Adds a new ServiceNow CMDB table configuration to an existing integration. An integration may contain at most 8 tables. New tables are created with `status: disabled`; enable synchronization separately once the configuration has been validated. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.write`

    POST /enrichment/integrations/servicenow/{integration_id}/tables

  • Write

    Enable CMDB table sync

    Enables data synchronization for a ServiceNow CMDB table configuration. Once enabled, the table's enrichment schema is populated with CI data from ServiceNow and kept up to date with periodic syncs. This operation is idempotent — enabling an already-enabled table succeeds. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.write`

    POST /enrichment/integrations/servicenow/{integration_id}/tables/{table_id}/enable

  • Write

    Create ServiceNow credentials

    Creates the ServiceNow API credentials used to authenticate synchronization and test requests. Only one credential set is allowed per account, and it is shared across the account's ServiceNow integration. The password is never returned in responses. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.write`

    POST /enrichment/integrations/servicenow/credentials

  • Destructive

    Delete a ServiceNow integration

    Deletes a ServiceNow enrichment integration, including all of its CMDB table configurations and their generated enrichment schemas, and disables any associated data synchronization. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.write`

    DELETE /enrichment/integrations/servicenow/{integration_id}

  • Destructive

    Update a CMDB table

    Replaces a ServiceNow CMDB table configuration. This is a full replacement — all fields, including `ci_table_name` and the complete `field_mappings` list, must be provided. A table can only be updated while its synchronization is disabled and before its initial backfill has started. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.write`

    PUT /enrichment/integrations/servicenow/{integration_id}/tables/{table_id}

  • Destructive

    Remove a CMDB table

    Removes a ServiceNow CMDB table configuration from an integration. The table's generated enrichment schema is removed and its data synchronization is disabled. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.write`

    DELETE /enrichment/integrations/servicenow/{integration_id}/tables/{table_id}

  • Destructive

    Update ServiceNow credentials

    Updates the ServiceNow credentials. Supports partial updates — only the fields provided in the request are changed. If a password is provided, it replaces the stored password. The password is never returned. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.write`

    PUT /enrichment/integrations/servicenow/credentials/{credentials_id}

  • Destructive

    Delete ServiceNow credentials

    Deletes the ServiceNow credentials. Credentials cannot be deleted while they are associated with an existing ServiceNow integration; delete the integration first. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.write`

    DELETE /enrichment/integrations/servicenow/credentials/{credentials_id}

Enrichment Schemas

  • Read

    Query enrichment data

    Query an enrichment schema for records matching a set of field values. Supply up to 3 query fields; all must match. Returns at most one record for standard schemas, or multiple records for schemas that use a discriminator field. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.read`

    POST /enrichment/query

  • Read

    List enrichment schemas

    Lists all enrichment schemas for the account. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.read`

    GET /enrichment/schemas

  • Read

    Get an enrichment schema

    Retrieves a specific enrichment schema by ID. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.read`

    GET /enrichment/schemas/{schema_id}

  • Read

    List enrichment records

    Retrieves a page of enrichment records for a schema. Results are cursor-paginated. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.read`

    GET /enrichment/schemas/{schema_id}/records

  • Write

    Create an enrichment schema

    Creates an enrichment schema. Provide a JSON body to define the schema explicitly (returns `201`), or upload a CSV file as `multipart/form-data` or `text/csv` to auto-generate a schema from the file's columns — the first column becomes a query field and the rest become enriched fields (returns `202` once the file is accepted for processing). A schema must include 1-3 query fields and at least one enriched field, up to 25 fields total, with unique (case-insensitive) field names. Schemas created through the API are always `CSV`, and an account may have at most 25 CSV schemas. CSV uploads are limited to 10 MB. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.write`

    POST /enrichment/schemas

  • Destructive

    Update an enrichment schema

    Updates the name and/or description of an enrichment schema. At least one of `name` or `description` must be provided. Schema fields cannot be changed after creation. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.write`

    PUT /enrichment/schemas/{schema_id}

  • Destructive

    Delete an enrichment schema

    Soft-deletes an enrichment schema and returns the deleted schema. Only `CSV` schemas can be deleted; `SERVICENOW` schemas are managed by the ServiceNow CMDB integration. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.write`

    DELETE /enrichment/schemas/{schema_id}

  • Destructive

    Upload CSV records

    Uploads a CSV file of enrichment records into an existing schema, as `multipart/form-data` or `text/csv`. The file is accepted for asynchronous processing (returns `202`) and is limited to 10 MB. The CSV columns must align with the schema's fields: missing columns result in empty values and extra columns are ignored. Records are keyed by their query-field values, so uploading a row whose query values match an existing record updates that record. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.write`

    POST /enrichment/schemas/{schema_id}/records

  • Destructive

    Delete an enrichment record

    Deletes a single enrichment record by ID and returns the deleted record. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Scoped OAuth requires: `contextual_data.write`

    DELETE /enrichment/schemas/{schema_id}/records/{record_id}

Escalation Policies

  • Read

    List escalation policies

    List all of the existing escalation policies. Escalation policies define which user should be alerted at which time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#escalation-policies) Scoped OAuth requires: `escalation_policies.read`

    GET /escalation_policies

  • Read

    Get an escalation policy

    Get information about an existing escalation policy and its rules. Escalation policies define which user should be alerted at which time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#escalation-policies) Scoped OAuth requires: `escalation_policies.read`

    GET /escalation_policies/{id}

  • Read

    List audit records for an escalation policy

    The returned records are sorted by the `execution_time` from newest to oldest. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set. For more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/). Scoped OAuth requires: `audit_records.read`

    GET /escalation_policies/{id}/audit/records

  • Write

    Create an escalation policy

    Creates a new escalation policy. At least one escalation rule must be provided. Escalation policies define which user should be alerted at which time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#escalation-policies) Scoped OAuth requires: `escalation_policies.write`

    POST /escalation_policies

  • Destructive

    Delete an escalation policy

    Deletes an existing escalation policy and rules. The escalation policy must not be in use by any services. Escalation policies define which user should be alerted at which time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#escalation-policies) Scoped OAuth requires: `escalation_policies.write`

    DELETE /escalation_policies/{id}

  • Destructive

    Update an escalation policy

    Updates an existing escalation policy and rules. Escalation policies define which user should be alerted at which time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#escalation-policies) Scoped OAuth requires: `escalation_policies.write`

    PUT /escalation_policies/{id}

Event Orchestrations

  • Read

    List Event Orchestrations

    List all Global Event Orchestrations on an Account. Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`

    GET /event_orchestrations

  • Read

    Get an Orchestration

    Get a Global Event Orchestration. Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`

    GET /event_orchestrations/{id}

  • Read

    List Integrations for an Event Orchestration

    List the Integrations associated with this Event Orchestrations. You can use a Routing Key from these Integrations to send events to PagerDuty! For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`

    GET /event_orchestrations/{id}/integrations

  • Read

    Get an Integration for an Event Orchestration

    Get an Integration associated with this Event Orchestrations. You can use the Routing Key from this Integration to send events to PagerDuty! For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`

    GET /event_orchestrations/{id}/integrations/{integration_id}

  • Read

    Get the Global Orchestration for an Event Orchestration

    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](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`

    GET /event_orchestrations/{id}/global

  • Read

    Get the Router for an Event Orchestration

    Get a Global Orchestration's Routing Rules. An Orchestration Router allows you to create a set of Event Rules. The Router evaluates Events you send to this Global Orchestration against each of its rules, one at a time, and routes the event to a specific Service based on the first rule that matches. If an event doesn't match any rules, it'll be sent to service specified in as the `catch_all` or the "Unrouted" Orchestration if no service is specified. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`

    GET /event_orchestrations/{id}/router

  • Read

    Get the Unrouted Orchestration for an Event Orchestration

    Get a Global Event Orchestration's Rules for Unrouted events. An Unrouted Orchestration allows you to create a set of Event Rules that will be evaluated against all events that don't match any rules in the Global Orchestration's Router. Events that reach the Unrouted Orchestration will never be routed to a specific Service. The Unrouted Orchestration evaluates Events sent to it 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 Unrouted Orchestration for further processing. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`

    GET /event_orchestrations/{id}/unrouted

  • Read

    Get the Service Orchestration for a Service

    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](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.read`

    GET /event_orchestrations/services/{service_id}

  • Read

    Get the Service Orchestration active status for a Service

    Get a Service Orchestration's active status. A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false). For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.read`

    GET /event_orchestrations/services/{service_id}/active

  • Read

    List Cache Variables for a Global Event Orchestration

    List Cache Variables for a Global Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`

    GET /event_orchestrations/{id}/cache_variables

  • Read

    Get a Cache Variable for a Global Event Orchestration

    Get a Cache Variable for a Global Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.read`

    GET /event_orchestrations/{id}/cache_variables/{cache_variable_id}

  • Read

    Get Data for an External Data Cache Variable on a Global Event Orchestration

    Get the data for an `external_data` type Cache Variable on a Global Orchestration. Use External Data type Cache Variables to store string, number, or boolean values via a dedicated API endpoint. These stored values can then be used in conditions or actions in Event Orchestration rules. For more information see the [Knowledge Base](https://support.pagerduty.com/main/docs/event-orchestration-cache-variables) Scoped OAuth requires: `event_orchestrations.read`

    GET /event_orchestrations/{id}/cache_variables/{cache_variable_id}/data

  • Read

    List Cache Variables for a Service Event Orchestration

    List Cache Variables for a Service Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.read`

    GET /event_orchestrations/services/{service_id}/cache_variables

  • Read

    Get a Cache Variable for a Service Event Orchestration

    Get a Cache Variable for a Service Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.read`

    GET /event_orchestrations/services/{service_id}/cache_variables/{cache_variable_id}

  • Read

    Get Data for an External Data Cache Variable on a Service Event Orchestration

    Get the data for an `external_data` type Cache Variable for a Service Event Orchestration. Use External Data type Cache Variables to store string, number, or boolean values via a dedicated API endpoint. These stored values can then be used in conditions or actions in Event Orchestration rules. For more information see the [Knowledge Base](https://support.pagerduty.com/main/docs/event-orchestration-cache-variables) Scoped OAuth requires: `services.read`

    GET /event_orchestrations/services/{service_id}/cache_variables/{cache_variable_id}/data

  • Read

    List Enablements for an Event Orchestration

    List all feature enablement settings for an Event Orchestration. Currently, only the `aiops` enablement is supported. For any account with the AIOps product addon, every Event Orchestration will have AIOps features enabled by default. **Warning conditions**: - If the account is not entitled to use AIOps features, a warning will be returned alongside the enablement data. For PDRP customers, this feature is branded **Signal Intelligence** in the PagerDuty product UI. The API field names and values (e.g. `aiops`) are unchanged. Scoped OAuth requires: `event_orchestrations.read`

    GET /event_orchestrations/{id}/enablements

  • Write

    Create an Orchestration

    Create a Global Event Orchestration. Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`

    POST /event_orchestrations

  • Write

    Create an Integration for an Event Orchestration

    Create an Integration associated with this Event Orchestration. You can then use the Routing Key from this new Integration to send events to PagerDuty! For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`

    POST /event_orchestrations/{id}/integrations

  • Write

    Migrate an Integration from one Event Orchestration to another

    Move an Integration and its Routing Key from the Event Orchestration specified in the request payload, to the Event Orchestration specified in the request URL. Any future events sent to this Integration's Routing Key will be processed by this Event Orchestration's Rules. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`

    POST /event_orchestrations/{id}/integrations/migration

  • Write

    Create a Cache Variable for a Global Event Orchestration

    Create a Cache Variable for a Global Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`

    POST /event_orchestrations/{id}/cache_variables

  • Write

    Create a Cache Variable for a Service Event Orchestration

    Create a Cache Variable for a Service Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.write`

    POST /event_orchestrations/services/{service_id}/cache_variables

  • Destructive

    Update an Orchestration

    Update a Global Event Orchestration. Global Event Orchestrations allow you define a set of Global Rules and Router Rules, so that when you ingest events using the Orchestration's Routing Key your events will have actions applied via the Global Rules & then routed to the correct Service by the Router Rules, based on the event's content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`

    PUT /event_orchestrations/{id}

  • Destructive

    Delete an Orchestration

    Delete a Global Event Orchestration. Once deleted, you will no longer be able to ingest events into PagerDuty using this Orchestration's Routing Key. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`

    DELETE /event_orchestrations/{id}

  • Destructive

    Update an Integration for an Event Orchestration

    Update an Integration associated with this Event Orchestrations. You can use the Routing Key from this Integration to send events to PagerDuty! For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`

    PUT /event_orchestrations/{id}/integrations/{integration_id}

  • Destructive

    Delete an Integration for an Event Orchestration

    Delete an Integration and its associated Routing Key. Once deleted, PagerDuty will drop all future events sent to PagerDuty using the Routing Key. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`

    DELETE /event_orchestrations/{id}/integrations/{integration_id}

  • Destructive

    Update the Global Orchestration for an Event Orchestration

    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](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`

    PUT /event_orchestrations/{id}/global

  • Destructive

    Update the Router for an Event Orchestration

    Update a Global Orchestration's Routing Rules. An Orchestration Router allows you to create a set of Event Rules. The Router evaluates Events you send to this Global Orchestration against each of its rules, one at a time, and routes the event to a specific Service based on the first rule that matches. If an event doesn't match any rules, it'll be sent to service specified in as the `catch_all` or the "Unrouted" Orchestration if no service is specified. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`

    PUT /event_orchestrations/{id}/router

  • Destructive

    Update the Unrouted Orchestration for an Event Orchestration

    Update a Global Event Orchestration's Rules for Unrouted events. An Unrouted Orchestration allows you to create a set of Event Rules that will be evaluated against all events that don't match any rules in the Global Orchestration's Router. Events that reach the Unrouted Orchestration will never be routed to a specific Service. The Unrouted Orchestration evaluates Events sent to it 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 Unrouted Orchestration for further processing. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`

    PUT /event_orchestrations/{id}/unrouted

  • Destructive

    Update the Service Orchestration for a Service

    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](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.write`

    PUT /event_orchestrations/services/{service_id}

  • Destructive

    Update the Service Orchestration active status for a Service

    Update a Service Orchestration's active status. A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false). For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.write`

    PUT /event_orchestrations/services/{service_id}/active

  • Destructive

    Update a Cache Variable for a Global Event Orchestration

    Update a Cache Variable for a Global Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`

    PUT /event_orchestrations/{id}/cache_variables/{cache_variable_id}

  • Destructive

    Delete a Cache Variable for a Global Event Orchestration

    Delete a Cache Variable for a Global Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `event_orchestrations.write`

    DELETE /event_orchestrations/{id}/cache_variables/{cache_variable_id}

  • Destructive

    Update Data for an External Data Cache Variable on a Global Event Orchestration

    Update data for an `external_data` type Cache Variable on a Global Event Orchestration Use External Data type Cache Variables to store string, number, or boolean values via a dedicated API endpoint. These stored values can then be used in conditions or actions in Event Orchestration rules. For more information see the [Knowledge Base](https://support.pagerduty.com/main/docs/event-orchestration-cache-variables) Scoped OAuth requires: `event_orchestrations.write`

    PUT /event_orchestrations/{id}/cache_variables/{cache_variable_id}/data

  • Destructive

    Delete Data for an External Data Cache Variable on a Global Event Orchestration

    Delete data for an `external_data` type Cache Variable on a Global Event Orchestration Use External Data type Cache Variables to store string, number, or boolean values via a dedicated API endpoint. These stored values can then be used in conditions or actions in Event Orchestration rules. For more information see the [Knowledge Base](https://support.pagerduty.com/main/docs/event-orchestration-cache-variables) Scoped OAuth requires: `event_orchestrations.write`

    DELETE /event_orchestrations/{id}/cache_variables/{cache_variable_id}/data

  • Destructive

    Update a Cache Variable for a Service Event Orchestration

    Update a Cache Variable for a Service Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.write`

    PUT /event_orchestrations/services/{service_id}/cache_variables/{cache_variable_id}

  • Destructive

    Delete a Cache Variable for a Service Event Orchestration

    Delete a Cache Variable for a Service Event Orchestration. Cache Variables allow you to store event data on an Event Orchestration, which can then be used in Event Orchestration rules as part of conditions or actions. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#event-orchestrations) Scoped OAuth requires: `services.write`

    DELETE /event_orchestrations/services/{service_id}/cache_variables/{cache_variable_id}

  • Destructive

    Update Data for an External Data Cache Variable on a Service Event Orchestration

    Update the data for an `external_data` type Cache Variable on a Service Event Orchestration. Use External Data type Cache Variables to store string, number, or boolean values via a dedicated API endpoint. These stored values can then be used in conditions or actions in Event Orchestration rules. For more information see the [Knowledge Base](https://support.pagerduty.com/main/docs/event-orchestration-cache-variables) Scoped OAuth requires: `services.write`

    PUT /event_orchestrations/services/{service_id}/cache_variables/{cache_variable_id}/data

  • Destructive

    Delete Data for an External Data Cache Variable on a Service Event Orchestration

    Delete Data for an `external_data` type Cache Variable on a Service Event Orchestration. Use External Data type Cache Variables to store string, number, or boolean values via a dedicated API endpoint. These stored values can then be used in conditions or actions in Event Orchestration rules. For more information see the [Knowledge Base](https://support.pagerduty.com/main/docs/event-orchestration-cache-variables) Scoped OAuth requires: `services.write`

    DELETE /event_orchestrations/services/{service_id}/cache_variables/{cache_variable_id}/data

  • Destructive

    Update an Enablement for an Event Orchestration

    Update the feature enablement setting for a specific product addon on an Event Orchestration. This setting controls enabling or disabling the set of features contained within the addon. Currently, only `aiops` is supported as a valid feature enablement. **Warning conditions**: - If the account is not entitled to use AIOps features, the setting will be updated, but a warning will be returned. For PDRP customers, this feature is branded **Signal Intelligence** in the PagerDuty product UI. The API field names and values (e.g. `aiops`) are unchanged. Scoped OAuth requires: `event_orchestrations.write`

    PUT /event_orchestrations/{id}/enablements/{feature_name}

Extension Schemas

  • Read

    List extension schemas

    List all extension schemas. A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extension-schemas) Scoped OAuth requires: `extension_schemas.read`

    GET /extension_schemas

  • Read

    Get an extension vendor

    Get details about one specific extension vendor. A PagerDuty extension vendor represents a specific type of outbound extension such as Generic Webhook, Slack, ServiceNow. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extension-schemas) Scoped OAuth requires: `extension_schemas.read`

    GET /extension_schemas/{id}

Event Enrichments

  • Read

    List Event Enrichments

    Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Retrieve a list of all Event Enrichments in the account.

    GET /enrichment/event_enrichments

  • Read

    Get the account default Event Enrichment

    Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields. The default Event Enrichment gets applied to every Event Orchestration or Service that is not already associated to any other Event Enrichment <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Retrieve the account default Event Enrichment.

    GET /enrichment/event_enrichments/default

  • Read

    Get an Event Enrichment

    Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Retrieve details of a specific Event Enrichment.

    GET /enrichment/event_enrichments/{id}

  • Read

    List Event Enrichment associations

    Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields. Associating an Event Orchestration or Service with an Event Enrichment allows for the enrichment to be evaluated when events are ingested for that Event Orchestration or Service <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Retrieve all items (Services or Event Orchestrations) associated with an Event Enrichment. If the API key lacks view access to an associated target, that item will not be returned in the results.

    GET /enrichment/event_enrichments/{id}/associations

  • Read

    Get Event Enrichment rules

    Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Get the rules associated with an Event Enrichment.

    GET /enrichment/event_enrichments/{id}/rules

  • Write

    Create an Event Enrichment

    Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Create a new Event Enrichment.

    POST /enrichment/event_enrichments

  • Write

    Add Event Enrichment associations

    Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields. Associating an Event Orchestration or Service with an Event Enrichment allows for the enrichment to be evaluated when events are ingested for that Event Orchestration or Service <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Add new associations between an Event Enrichment and Services or Event Orchestrations.

    POST /enrichment/event_enrichments/{id}/associations

  • Destructive

    Mark an Event Enrichment as the account default

    Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields. The default Event Enrichment gets applied to every Event Orchestration or Service that is not already associated to any other Event Enrichment <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Mark a specific Event Enrichment as the account default. Set the request body to `default: null` to clear the current default.

    PUT /enrichment/event_enrichments/default

  • Destructive

    Update an Event Enrichment

    Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Update an existing Event Enrichment.

    PUT /enrichment/event_enrichments/{id}

  • Destructive

    Delete an Event Enrichment

    Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Delete a specific Event Enrichment. The user must have "Delete" privileges for both the Event Enrichment and all of its associated items.

    DELETE /enrichment/event_enrichments/{id}

  • Destructive

    Delete Event Enrichment associations

    Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields. Associating an Event Orchestration or Service with an Event Enrichment allows for the enrichment to be evaluated when events are ingested for that Event Orchestration or Service <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Remove associations between an Event Enrichment and Services or Event Orchestrations.

    DELETE /enrichment/event_enrichments/{id}/associations

  • Destructive

    Update Event Enrichment rules

    Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields. <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Update the enrichment rules for a specific Event Enrichment. Performs a full replacement of the rules set.

    PUT /enrichment/event_enrichments/{id}/rules

Extensions

  • Read

    List extensions

    List existing extensions. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: `extensions.read`

    GET /extensions

  • Read

    Get an extension

    Get details about an existing extension. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: `extensions.read`

    GET /extensions/{id}

  • Write

    Create an extension

    Create a new Extension. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: `extensions.write`

    POST /extensions

  • Write

    Enable an extension

    Enable an extension that is temporarily disabled. (This API does not require a request body.) Extensions are representations of Extension Schema objects that are attached to Services. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: `extensions.write`

    POST /extensions/{id}/enable

  • Destructive

    Delete an extension

    Delete an existing extension. Once the extension is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this extension. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: `extensions.write`

    DELETE /extensions/{id}

  • Destructive

    Update an extension

    Update an existing extension. Extensions are representations of Extension Schema objects that are attached to Services. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#extensions) Scoped OAuth requires: `extensions.write`

    PUT /extensions/{id}

Incident Workflows

  • Read

    List Incident Workflows

    List existing Incident Workflows. This is the best method to use to list all Incident Workflows in your account. If your use case requires listing Incident Workflows associated with a particular Service, you can use the "List Triggers" method to find Incident Workflows configured to start for Incidents in a given Service. An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. Scoped OAuth requires: `incident_workflows.read`

    GET /incident_workflows

  • Read

    Get an Incident Workflow

    Get an existing Incident Workflow An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. Scoped OAuth requires: `incident_workflows.read`

    GET /incident_workflows/{id}

  • Read

    List Actions

    List Incident Workflow Actions Scoped OAuth requires: `incident_workflows.read`

    GET /incident_workflows/actions

  • Read

    Get an Action

    Get an Incident Workflow Action Scoped OAuth requires: `incident_workflows.read`

    GET /incident_workflows/actions/{id}

  • Read

    List Triggers

    List existing Incident Workflow Triggers Scoped OAuth requires: `incident_workflows.read`

    GET /incident_workflows/triggers

  • Read

    Get a Trigger

    Retrieve an existing Incident Workflows Trigger Scoped OAuth requires: `incident_workflows.read`

    GET /incident_workflows/triggers/{id}

  • Write

    Create an Incident Workflow

    Create a new Incident Workflow An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. Scoped OAuth requires: `incident_workflows.write`

    POST /incident_workflows

  • Write

    Start an Incident Workflow Instance

    Start an Instance of an Incident Workflow. Sometimes referred to as "triggering a workflow on an incident." An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. Scoped OAuth requires: `incident_workflows:instances.write`

    POST /incident_workflows/{id}/instances

  • Write

    Create a Trigger

    Create new Incident Workflow Trigger Scoped OAuth requires: `incident_workflows.write`

    POST /incident_workflows/triggers

  • Write

    Associate a Trigger and Service

    Associate a Service with an existing Incident Workflow Trigger Scoped OAuth requires: `incident_workflows.write`

    POST /incident_workflows/triggers/{id}/services

  • Destructive

    Delete an Incident Workflow

    Delete an existing Incident Workflow An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. Scoped OAuth requires: `incident_workflows.write`

    DELETE /incident_workflows/{id}

  • Destructive

    Update an Incident Workflow

    Update an Incident Workflow An Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident. Scoped OAuth requires: `incident_workflows.write`

    PUT /incident_workflows/{id}

  • Destructive

    Update a Trigger

    Update an existing Incident Workflow Trigger Scoped OAuth requires: `incident_workflows.write`

    PUT /incident_workflows/triggers/{id}

  • Destructive

    Delete a Trigger

    Delete an existing Incident Workflow Trigger Scoped OAuth requires: `incident_workflows.write`

    DELETE /incident_workflows/triggers/{id}

  • Destructive

    Dissociate a Trigger and Service

    Remove a an existing Service from an Incident Workflow Trigger Scoped OAuth requires: `incident_workflows.write`

    DELETE /incident_workflows/triggers/{trigger_id}/services/{service_id}

Incidents

  • Read

    List incidents

    List existing incidents. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.read`

    GET /incidents

  • Read

    Get an incident

    Show detailed information about an incident. Accepts either an incident id, or an incident number. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.read`

    GET /incidents/{id}

  • Read

    List alerts for an incident

    List alerts for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.read`

    GET /incidents/{id}/alerts

  • Read

    Get an alert

    Show detailed information about an alert. Accepts an alert id. An incident represents a problem or an issue that needs to be addressed and resolved. When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.read`

    GET /incidents/{id}/alerts/{alert_id}

  • Read

    List Business Services impacted by the given Incident

    Retrieve a list of Business Services that are being impacted by the given Incident. Scoped OAuth requires: `incidents.read`

    GET /incidents/{id}/business_services/impacts

  • Read

    Get Custom Field Values

    Get custom field values for an incident. <!-- theme: warning --> Scoped OAuth requires: `incidents.read`

    GET /incidents/{id}/custom_fields/values

  • Read

    List log entries for an incident

    List log entries for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. A Log Entry are a record of all events on your account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.read`

    GET /incidents/{id}/log_entries

  • Read

    List notes for an incident

    List existing notes for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.read`

    GET /incidents/{id}/notes

  • Read

    Get Outlier Incident

    Gets Outlier Incident information for a given Incident on its Service. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#outlier-incident) Scoped OAuth requires: `incidents.read`

    GET /incidents/{id}/outlier_incident

  • Read

    Get Past Incidents

    Past Incidents returns Incidents within the past 6 months that have similar metadata and were generated on the same Service as the parent Incident. By default, 5 Past Incidents are returned. Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#past_incidents) Scoped OAuth requires: `incidents.read`

    GET /incidents/{id}/past_incidents

  • Read

    Get Related Incidents

    Returns the 20 most recent Related Incidents that are impacting other Responders and Services. Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#related_incidents) Scoped OAuth requires: `incidents.read`

    GET /incidents/{id}/related_incidents

  • Read

    Get Scribe transcripts for an incident

    Get download links for the Scribe transcripts of the specified incident. Only Scribes that have completed are returned; a Scribe that is still in progress does not appear in the response. Each entry contains a presigned `download_url` for a single transcript format, selected with the `format` query parameter (`enhanced` by default, or `raw`). The `download_url` is time-limited and expires after one hour, so request a new one if it has expired. `download_url` is `null` when the transcript is not available for the requested format. Scoped OAuth requires: `incidents.read`

    GET /incidents/{id}/scribe_transcripts

  • Read

    List Notification Subscribers

    Retrieve a list of Notification Subscribers on the Incident. <!-- theme: warning --> > Users must be added through `POST /incident/{id}/status_updates/subscribers` to be returned from this endpoint. Scoped OAuth requires: `subscribers.read`

    GET /incidents/{id}/status_updates/subscribers

  • Write

    Create an Incident

    Create an incident synchronously without a corresponding event from a monitoring service. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write` This API operation has operation specific rate limits. See the [Rate Limits](https://developer.pagerduty.com/docs/72d3b724589e3-rest-api-rate-limits) page for more information.

    POST /incidents

  • Write

    Create a note on an incident

    Create a new note for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. A maximum of 2000 notes can be added to an incident. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`

    POST /incidents/{id}/notes

  • Write

    Create a responder request for an incident

    Send a new responder request for the specified incident. This endpoint requires the account to have access to the [responder requests](https://support.pagerduty.com/main/docs/add-responders) feature. **Account Ability Requirement**: The account must have the `coordinated_responding` ability. Returns 402 Payment Required if the ability is missing. You can use the [List Abilities API](openapiv3.json/paths/~1abilities/get) to check account abilities. A user or an escalation policy can be requested. The responder targets will be notified via their high urgency notification rules, until the target user has either accepted or declined the request. Previous responder requests for a given target can be cancelled (preventing them from further notifying or escalating), with the [Cancel Responder Requests](openapiv3.json/paths/~1incidents~1{id}~1responder_requests~1cancel/put) endpoint. Scoped OAuth requires: `incidents.write`

    POST /incidents/{id}/responder_requests

  • Write

    Snooze an incident

    Snooze an incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`

    POST /incidents/{id}/snooze

  • Write

    Create a status update on an incident

    Create a new status update for the specified incident. Optionally pass `subject` and `html_message` properties in the request body to override the email notification that gets sent. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`

    POST /incidents/{id}/status_updates

  • Write

    Add Notification Subscribers

    Subscribe the given entities to Incident Status Update Notifications. Scoped OAuth requires: `subscribers.write`

    POST /incidents/{id}/status_updates/subscribers

  • Destructive

    Manage incidents

    Acknowledge, resolve, escalate or reassign one or more incidents. An incident represents a problem or an issue that needs to be addressed and resolved. A maximum of 250 incidents may be updated at a time. If more than this number of incidents are given, the API will respond with status 413 (Request Entity Too Large). For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write` This API operation has operation specific rate limits. See the [Rate Limits](https://developer.pagerduty.com/docs/72d3b724589e3-rest-api-rate-limits) page for more information.

    PUT /incidents

  • Destructive

    Update an incident

    Acknowledge, resolve, escalate or reassign an incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`

    PUT /incidents/{id}

  • Destructive

    Manage alerts

    Resolve multiple alerts or associate them with different incidents. An incident represents a problem or an issue that needs to be addressed and resolved. An alert represents a digital signal that was emitted to PagerDuty by the monitoring systems that detected or identified the issue. A maximum of 250 alerts may be updated at a time. If more than this number of alerts are given, the API will respond with status 413 (Request Entity Too Large). For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`

    PUT /incidents/{id}/alerts

  • Destructive

    Update an alert

    Resolve an alert or associate an alert with a new parent incident. An incident represents a problem or an issue that needs to be addressed and resolved. When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`

    PUT /incidents/{id}/alerts/{alert_id}

  • Destructive

    Manually change an Incident's Impact on a Business Service.

    Change Impact of an Incident on a Business Service. Scoped OAuth requires: `incidents.write`

    PUT /incidents/{id}/business_services/{business_service_id}/impacts

  • Destructive

    Update Custom Field Values

    Set custom field values for an incident. Scoped OAuth requires: `incidents.write`

    PUT /incidents/{id}/custom_fields/values

  • Destructive

    Merge incidents

    Merge a list of source incidents into the target [incident](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#incidents). After the merge is performed the target incident will contain the source incidents' [alerts](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#alerts), and the source incidents will be resolved. Only incidents that have alerts or incidents that were created manually in the UI can be merged. Open incidents cannot be merged into a resolved incident. The target incident must be open. An incident cannot have more than 1000 alerts. The server will return an error if merging the source incidents will result in the target incident having more than 1000 alerts. Scoped OAuth requires: `incidents.write`

    PUT /incidents/{id}/merge

  • Destructive

    Update a note on an incident

    Update an existing note for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`

    PUT /incidents/{id}/notes/{note_id}

  • Destructive

    Delete a note on an incident

    Delete an existing note for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidents) Scoped OAuth requires: `incidents.write`

    DELETE /incidents/{id}/notes/{note_id}

  • Destructive

    Cancel responder requests for an incident

    Cancel pending responder requests for the specified incident. This endpoint allows you to cancel responder requests for specified targets that are in a pending state. Only responders who have not yet joined or declined can be cancelled. This endpoint requires the account to have access to the [responder requests](https://support.pagerduty.com/main/docs/add-responders) feature. **Account Ability Requirement**: The account must have the `coordinated_responding` ability. Returns 402 Payment Required if the ability is missing. You can use the [List Abilities API](openapiv3.json/paths/~1abilities/get) to check account abilities. **State Constraints**: Only responders in the `pending` state can be cancelled. Responders who have already `joined` or `declined` are not affected (the result will indicate their current state). **User vs Escalation Policy Behavior**: - **Users**: Direct cancellation, updates state to `user_cancelled`, stops notifications - **Escalation Policies**: Stops the escalation process, updates state of all pending users from that escalation policy to `user_cancelled` and stops notifications **Result Values**: - `cancelled`: Successfully cancelled - `joined`: User already joined (not cancelled) - `declined`: User already declined (not cancelled) - `not_found`: Target not found or not part of any responder request Scoped OAuth requires: `incidents.write`

    PUT /incidents/{id}/responder_requests/cancel

  • Destructive

    Remove Notification Subscriber

    Unsubscribes the matching Subscribers from Incident Status Update Notifications. Scoped OAuth requires: `subscribers.write`

    POST /incidents/{id}/status_updates/unsubscribe

Incident Reviews

  • Read

    List Incident Reviews

    List the Incident Reviews on the account, newest first by creation time. Only Incident Reviews on Incidents the caller can see are returned. Each entry is a summary; fetch the Incident Review by its Incident to get its sections. This endpoint uses cursor pagination. Omit `cursor` for the first page, then pass the `next_cursor` from the previous response until it is `null`. Scoped OAuth requires: `incident_reviews.read`

    GET /incidents/reviews

  • Read

    List action items across all Incident Reviews

    List the action items across every Incident Review on the account, oldest first by creation time. Only action items on Incident Reviews the caller can see are returned. Each action item's `incident_id` identifies the Incident Review it belongs to. This endpoint uses cursor pagination. Omit `cursor` for the first page, then pass the `next_cursor` from the previous response until it is `null`. Scoped OAuth requires: `incident_reviews.read`

    GET /incidents/reviews/action_items

  • Read

    Get an Incident Review

    Get the Incident Review for the specified Incident. An Incident Review is a structured, post-resolution record of what happened during an Incident. Each Incident has at most one Incident Review. Returns `404` if the Incident has no Incident Review, or if the caller cannot see it. Scoped OAuth requires: `incident_reviews.read`

    GET /incidents/{id}/review

  • Read

    List action items for an Incident Review

    List the action items on the Incident Review for the specified Incident, oldest first by creation time. Returns an empty list for an Incident Review that has no action items, and `404` when the Incident has no Incident Review, or if the caller cannot see it. This endpoint uses cursor pagination. Omit `cursor` for the first page, then pass the `next_cursor` from the previous response until it is `null`. Scoped OAuth requires: `incident_reviews.read`

    GET /incidents/{id}/review/action_items

  • Write

    Create an Incident Review

    Create an Incident Review for the specified Incident. An Incident can have at most one Incident Review, so this returns `400` if the Incident already has one. A caller that wants create-or-fetch behaviour should fall back to `GET` on failure. The new Incident Review follows the account's default template, which determines its sections. When called with a User API token, the caller owns the new Incident Review. An account API key may name an owner with `owner_user_id`. Returns `400` if `owner_user_id` is not a User on the account, or if a User API token names someone other than the caller. Scoped OAuth requires: `incident_reviews.write`

    POST /incidents/{id}/review

  • Write

    Add a marker to an Incident Review timeline

    Add a marker to the timeline of the Incident Review for the specified Incident. A marker highlights a point of interest on the timeline. Each entry in `notes` is added as its own event attached to the new marker. Returns `404` when the Incident has no Incident Review, or if the caller cannot see it, and `409` when the Incident Review is `completed` and must be reopened first. `409` is also returned if the Incident Review is locked, or if it uses a format this version of the API cannot edit. Scoped OAuth requires: `incident_reviews.write`

    POST /incidents/{id}/review/markers

  • Destructive

    Update an Incident Review

    Update the Incident Review for the specified Incident. This is a partial update: an omitted field leaves the current value unchanged. Moving `status` to `completed` is rejected with `409` while any required section is still unfilled. On accounts where completed Incident Reviews are read-only, any other change to a `completed` Incident Review is rejected with `409` until it is reopened by setting `status` to another value. Completing or reopening an Incident Review requires permission to complete it, or the request is rejected with `403`. `409` is also returned if the Incident Review is locked, or if it uses a format this version of the API cannot edit. Scoped OAuth requires: `incident_reviews.write`

    PUT /incidents/{id}/review

Incident Types

  • Read

    List incident types

    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. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidentType) Scoped OAuth requires: `incident_types.read`

    GET /incidents/types

  • Read

    Get an Incident Type

    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. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incident) Scoped OAuth requires: `incident_types.read`

    GET /incidents/types/{type_id_or_name}

  • Read

    List Incident Type Custom Fields

    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. Scoped OAuth requires: `custom_fields.read`

    GET /incidents/types/{type_id_or_name}/custom_fields

  • Read

    Get an Incident Type Custom Field

    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. Scoped OAuth requires: `custom_fields.read`

    GET /incidents/types/{type_id_or_name}/custom_fields/{field_id}

  • Read

    List Field Options on a Custom Field

    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. Scoped OAuth requires: `custom_fields.read`

    GET /incidents/types/{type_id_or_name}/custom_fields/{field_id}/field_options

  • Read

    Get a Field Option on a Custom Field

    Get a field option on 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. Scoped OAuth requires: `custom_fields.read`

    GET /incidents/types/{type_id_or_name}/custom_fields/{field_id}/field_options/{field_option_id}

  • Write

    Create an Incident Type

    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. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incidentType) Scoped OAuth requires: `incident_types.write`

    POST /incidents/types

  • Write

    Create a Custom Field for an Incident Type

    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. Scoped OAuth requires: `custom_fields.write`

    POST /incidents/types/{type_id_or_name}/custom_fields

  • Write

    Create a Field Option for a Custom Field

    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. Scoped OAuth requires: `custom_fields.write`

    POST /incidents/types/{type_id_or_name}/custom_fields/{field_id}/field_options

  • Destructive

    Update an Incident Type

    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. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#incident) Scoped OAuth requires: `incident_types.write`

    PUT /incidents/types/{type_id_or_name}

  • Destructive

    Update a Custom Field for an Incident Type

    Update a custom field for an incident type. Field Options can also be updated within the same call. 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. Scoped OAuth requires: `custom_fields.write`

    PUT /incidents/types/{type_id_or_name}/custom_fields/{field_id}

  • Destructive

    Delete a Custom Field for an Incident Type

    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. Scoped OAuth requires: `custom_fields.write`

    DELETE /incidents/types/{type_id_or_name}/custom_fields/{field_id}

  • Destructive

    Update a Field Option for a Custom Field

    Update 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. Scoped OAuth requires: `custom_fields.write`

    PUT /incidents/types/{type_id_or_name}/custom_fields/{field_id}/field_options/{field_option_id}

  • Destructive

    Delete a Field Option for a Custom Field

    Delete 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. Scoped OAuth requires: `custom_fields.write`

    DELETE /incidents/types/{type_id_or_name}/custom_fields/{field_id}/field_options/{field_option_id}

Incident Custom Fields

  • Read

    List Fields (deprecated)

    <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields/get) List Custom Fields on the Base Incident Type. Scoped OAuth requires: `custom_fields.read`

    GET /incidents/custom_fields

  • Read

    Get a Field (deprecated)

    <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields/{field_id}](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields~1{field_id}/get) Show detailed information about a Custom Field on the Base Incident Type. Scoped OAuth requires: `custom_fields.read`

    GET /incidents/custom_fields/{field_id}

  • Read

    List Field Options (deprecated)

    <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields/{field_id}/field_options](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields~1{field_id}~1field_options/get) List all enabled Field Options for a Custom Field on the Base Incident Type. Scoped OAuth requires: `custom_fields.read`

    GET /incidents/custom_fields/{field_id}/field_options

  • Write

    Create a Field (deprecated)

    <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields/post) Creates a new Custom Field on the Base Incident Type, along with the Field Options if provided. \ An account may have up to 10 Fields. Scoped OAuth requires: `custom_fields.write`

    POST /incidents/custom_fields

  • Write

    Create a Field Option (deprecated)

    <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields/{field_id}/field_options](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields~1{field_id}~1field_options/post) Create a new Field Option for a Custom Field on the Base Incident Type. Field Options may only be created for Fields that have `field_options`. A Field may have no more than 10 enabled options. Scoped OAuth requires: `custom_fields.write`

    POST /incidents/custom_fields/{field_id}/field_options

  • Destructive

    Update a Field (deprecated)

    <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields/{field_id}](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields~1{field_id}/put) Update a Custom Field on the Base Incident Type. Scoped OAuth requires: `custom_fields.write`

    PUT /incidents/custom_fields/{field_id}

  • Destructive

    Delete a Field (deprecated)

    <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields/{field_id}](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields~1{field_id}/delete) Delete a Custom Field from the Base Incident Type. Scoped OAuth requires: `custom_fields.write`

    DELETE /incidents/custom_fields/{field_id}

  • Destructive

    Update a Field Option (deprecated)

    <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields/{field_id}/field_options/{field_option_id}](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields~1{field_id}~1field_options~1{field_option_id}/put) Update a Field Option for a Custom Field on the Base Incident Type. Scoped OAuth requires: `custom_fields.write`

    PUT /incidents/custom_fields/{field_id}/field_options/{field_option_id}

  • Destructive

    Delete a Field Option (deprecated)

    <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated and only works for fields on the Base Incident Type. \ > For more flexibility, we recommend using the Incident Types endpoint: \ > [/incidents/types/{type_id_or_name}/custom_fields/{field_id}/field_options/{field_option_id}](openapiv3.json/paths/~1incidents~1types~1{type_id_or_name}~1custom_fields~1{field_id}~1field_options~1{field_option_id}/delete) Delete a Field Option for a Custom Field on the Base Incident Type. Scoped OAuth requires: `custom_fields.write`

    DELETE /incidents/custom_fields/{field_id}/field_options/{field_option_id}

IP Allow Lists

  • Read

    List IP allow lists

    Return all IP allow lists for the account. Only Account Owners, Global Admins, and Account API Keys can call this endpoint. Scoped OAuth requires: `ip_allow_lists.read`

    GET /ip_allow_lists

  • Read

    Get an IP allow list

    Return the IP allow list with the given `id`. Only Account Owners, Global Admins, and Account API Keys can call this endpoint. Scoped OAuth requires: `ip_allow_lists.read`

    GET /ip_allow_lists/{id}

  • Read

    List audit records for an IP allow list

    The response will include audit records with changes that are made to the given IP allow list. The returned records are sorted by the `execution_time` from newest to oldest. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set. For more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/). Scoped OAuth requires: `audit_records.read`

    GET /ip_allow_lists/{id}/audit/records

  • Write

    Create an IP allow list

    Create the account's IP allow list. Only Account Owners, Global Admins, and Account API Keys can call this endpoint. Scoped OAuth requires: `ip_allow_lists.write`

    POST /ip_allow_lists

  • Destructive

    Update an IP allow list

    Update the IP allow list with the given `id`. The request body fully replaces the writable fields. Only Account Owners, Global Admins, and Account API Keys can call this endpoint. Scoped OAuth requires: `ip_allow_lists.write`

    PUT /ip_allow_lists/{id}

  • Destructive

    Delete an IP allow list

    Delete the IP allow list with the given `id`. Subsequent `GET` and `PUT` requests for the same `id` will return `404`. The list is no longer enforced once deleted. Only Account Owners, Global Admins, and Account API Keys can call this endpoint. Scoped OAuth requires: `ip_allow_lists.write`

    DELETE /ip_allow_lists/{id}

Licenses

  • Read

    List License Allocations

    List the Licenses allocated to Users within your Account Scoped OAuth requires: `licenses.read`

    GET /license_allocations

  • Read

    List Licenses

    List the Licenses associated with your Account Scoped OAuth requires: `licenses.read`

    GET /licenses

Log Entries

  • Read

    List log entries

    List all of the incident log entries across the entire account. A log of all the events that happen to an Incident, and these are exposed as Log Entries. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#log-entries) Scoped OAuth requires: `incidents.read`

    GET /log_entries

  • Read

    Get a log entry

    Get details for a specific incident log entry. This method provides additional information you can use to get at raw event data. A log of all the events that happen to an Incident, and these are exposed as Log Entries. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#log-entries) Scoped OAuth requires: `incidents.read`

    GET /log_entries/{id}

  • Destructive

    Update log entry channel information.

    Update an existing incident log entry channel. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#log-entries) Scoped OAuth requires: `incidents.write`

    PUT /log_entries/{id}/channel

Maintenance Windows

  • Read

    List maintenance windows

    List existing maintenance windows, optionally filtered by service and/or team, or whether they are from the past, present or future. A Maintenance Window is used to temporarily disable one or more Services for a set period of time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#maintenance-windows) Scoped OAuth requires: `services.read`

    GET /maintenance_windows

  • Read

    Get a maintenance window

    Get an existing maintenance window. A Maintenance Window is used to temporarily disable one or more Services for a set period of time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#maintenance-windows) Scoped OAuth requires: `services.read`

    GET /maintenance_windows/{id}

  • Write

    Create a maintenance window

    Create a new maintenance window for the specified services. No new incidents will be created for a service that is in maintenance. A Maintenance Window is used to temporarily disable one or more Services for a set period of time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#maintenance-windows) Scoped OAuth requires: `services.write`

    POST /maintenance_windows

  • Destructive

    Delete or end a maintenance window

    Delete an existing maintenance window if it's in the future, or end it if it's currently on-going. If the maintenance window has already ended it cannot be deleted. A Maintenance Window is used to temporarily disable one or more Services for a set period of time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#maintenance-windows) Scoped OAuth requires: `services.write`

    DELETE /maintenance_windows/{id}

  • Destructive

    Update a maintenance window

    Update an existing maintenance window. A Maintenance Window is used to temporarily disable one or more Services for a set period of time. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#maintenance-windows) Scoped OAuth requires: `services.write`

    PUT /maintenance_windows/{id}

Notifications

  • Read

    List notifications

    List notifications for a given time range, optionally filtered by type (sms_notification, email_notification, phone_notification, or push_notification). A Notification is created when an Incident is triggered or escalated. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#notifications) Scoped OAuth requires: `users:notifications.read`

    GET /notifications

OAuth Delegations

  • Read

    Get OAuth delegations revocation requests status (deprecated)

    <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated as OAuth token revocation is now synchronous. Please use the [DELETE /oauth_delegations endpoint](https://developer.pagerduty.com/api-reference/ad1161db75db1-delete-all-o-auth-delegations) instead. Get the status of all OAuth delegations revocation requests for this account, specifically how many requests are still pending. As all requests are now synchronous, no pending requests will be found. This endpoint is limited to account owners and admins. Scoped OAuth requires: `oauth_delegations.read`

    GET /oauth_delegations/revocation_requests/status

  • Destructive

    Delete all OAuth delegations

    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. It also represents a user session in the PagerDuty web app. Deleting an OAuth delegation will revoke that instance of an app's access to that user or account. To grant access again, reauthorization/reauthentication will be required. This endpoint supports deleting mobile app OAuth delegations for a given user, which is equivalent to signing users out of the mobile app. It also supports deleting delegations of type web, which is equivalent to signing users out of the web app. This is a synchronous API. Scoped OAuth requires: `oauth_delegations.write`

    DELETE /oauth_delegations

On Calls

  • Read

    List all of the on-calls

    List the on-call entries during a given time range. An on-call represents a contiguous unit of time for which a User will be on call for a given Escalation Policy and Escalation Rules. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#on-calls) Scoped OAuth requires: `oncalls.read` This API operation has operation specific rate limits. See the [Rate Limits](https://developer.pagerduty.com/docs/72d3b724589e3-rest-api-rate-limits) page for more information.

    GET /oncalls

Paused Incident Reports

  • Read

    Get Paused Incident Reporting on Alerts

    Returns the 5 most recent alerts that were triggered after being paused and the 5 most recent alerts that were resolved after being paused for a given reporting period (maximum 6 months lookback period). Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#paused-incident-reports) Scoped OAuth requires: `incidents.read`

    GET /paused_incident_reports/alerts

  • Read

    Get Paused Incident Reporting counts

    Returns reporting counts for paused Incident usage for a given reporting period (maximum 6 months lookback period). Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#paused-incident-reports) Scoped OAuth requires: `incidents.read`

    GET /paused_incident_reports/counts

Priorities

  • Read

    List priorities

    List existing priorities, in order (most to least severe). A priority is a label representing the importance and impact of an incident. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#priorities) Scoped OAuth requires: `priorities.read`

    GET /priorities

Rulesets

  • Read

    List Rulesets

    List all Rulesets <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Scoped OAuth requires: `event_rules.read`

    GET /rulesets

  • Read

    Get a Ruleset

    Get a Ruleset. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Scoped OAuth requires: `event_rules.read`

    GET /rulesets/{id}

  • Read

    List Event Rules

    List all Event Rules on a Ruleset. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead. Scoped OAuth requires: `event_rules.read`

    GET /rulesets/{id}/rules

  • Read

    Get an Event Rule

    Get an Event Rule. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead. Scoped OAuth requires: `event_rules.read`

    GET /rulesets/{id}/rules/{rule_id}

  • Write

    Create a Ruleset

    Create a new Ruleset. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Scoped OAuth requires: `event_rules.write`

    POST /rulesets

  • Write

    Create an Event Rule

    Create a new Event Rule. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead. Scoped OAuth requires: `event_rules.write`

    POST /rulesets/{id}/rules

  • Destructive

    Update a Ruleset

    Update a Ruleset. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Scoped OAuth requires: `event_rules.write`

    PUT /rulesets/{id}

  • Destructive

    Delete a Ruleset

    Delete a Ruleset. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Scoped OAuth requires: `event_rules.write`

    DELETE /rulesets/{id}

  • Destructive

    Update an Event Rule

    Update an Event Rule. Note that the endpoint supports partial updates, so any number of the writable fields can be provided. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Note: Create and Update on rules will accept 'description' or 'summary' interchangeably as an extraction action target. Get and List on rules will always return 'summary' as the target. If you are expecting 'description' please change your automation code to expect 'summary' instead. Scoped OAuth requires: `event_rules.write`

    PUT /rulesets/{id}/rules/{rule_id}

  • Destructive

    Delete an Event Rule

    Delete an Event Rule. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Rulesets allow you to route events to an endpoint and create collections of Event Rules, which define sets of actions to take based on event content. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#rulesets) Scoped OAuth requires: `event_rules.write`

    DELETE /rulesets/{id}/rules/{rule_id}

Schedules

  • Read

    List schedules

    List the on-call schedules. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.read`

    GET /schedules

  • Read

    Get a schedule

    Show detailed information about a schedule, including entries for each layer. Scoped OAuth requires: `schedules.read`

    GET /schedules/{id}

  • Read

    List audit records for a schedule

    The returned records are sorted by the `execution_time` from newest to oldest. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set. For more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/). Scoped OAuth requires: `audit_records.read`

    GET /schedules/{id}/audit/records

  • Read

    List overrides

    List overrides for a given time range. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.read`

    GET /schedules/{id}/overrides

  • Read

    List users on call.

    List all of the users on call in a given schedule for a given time range. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `users.read`

    GET /schedules/{id}/users

  • Read

    Preview a schedule

    Preview what an on-call schedule would look like without saving it. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.write`

    POST /schedules/preview

  • Write

    Create a schedule

    Create a new on-call schedule. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.write`

    POST /schedules

  • Write

    Create one or more overrides

    Create one or more overrides, each for a specific user covering a specified time range. If you create an override on top of an existing override, the last created override will have priority. A Schedule determines the time periods that users are On-Call. Note: An older implementation of this endpoint only supported creating a single ocverride per request. That functionality is still supported, but deprecated and may be removed in the future. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.write`

    POST /schedules/{id}/overrides

  • Destructive

    Delete a schedule

    Delete an on-call schedule. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.write`

    DELETE /schedules/{id}

  • Destructive

    Update a schedule

    Update an existing on-call schedule. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.write`

    PUT /schedules/{id}

  • Destructive

    Delete an override

    Remove an override. You cannot remove a past override. If the override start time is before the current time, but the end time is after the current time, the override will be truncated to the current time. If the override is truncated, the status code will be 200 OK, as opposed to a 204 No Content for a successful delete. A Schedule determines the time periods that users are On-Call. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#schedules) Scoped OAuth requires: `schedules.write`

    DELETE /schedules/{id}/overrides/{override_id}

Service Dependencies

  • Read

    Get Business Service dependencies

    Get all immediate dependencies of any Business Service. Business Services model capabilities that span multiple technical services and that may be owned by several different teams. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.read`

    GET /service_dependencies/business_services/{id}

  • Read

    Get technical service dependencies

    Get all immediate dependencies of any technical service. Technical services are also known as `services`. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.read`

    GET /service_dependencies/technical_services/{id}

  • Write

    Associate service dependencies

    Create new dependencies between two services. Business services model capabilities that span multiple technical services and that may be owned by several different teams. A service can have a maximum of 2,000 dependencies with a depth limit of 100. If the limit is reached, the API will respond with an error. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.write`

    POST /service_dependencies/associate

  • Destructive

    Disassociate service dependencies

    Disassociate dependencies between two services. Business services model capabilities that span multiple technical services and that may be owned by several different teams. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#business-services) Scoped OAuth requires: `services.write`

    POST /service_dependencies/disassociate

Services

  • Read

    List services

    List existing Services. A service may represent an application, component, or team you wish to open incidents against. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.read`

    GET /services

  • Read

    Get a service

    Get details about an existing service. A service may represent an application, component, or team you wish to open incidents against. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.read`

    GET /services/{id}

  • Read

    List audit records for a service

    The returned records are sorted by the `execution_time` from newest to oldest. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set. For more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/). Scoped OAuth requires: `audit_records.read`

    GET /services/{id}/audit/records

  • Read

    View an integration

    Get details about an integration belonging to a service. A service may represent an application, component, or team you wish to open incidents against. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.read`

    GET /services/{id}/integrations/{integration_id}

  • Read

    List Service's Event Rules

    List Event Rules on a Service. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: `services.read`

    GET /services/{id}/rules

  • Read

    Get an Event Rule from a Service

    Get an Event Rule from a Service. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: `services.read`

    GET /services/{id}/rules/{rule_id}

  • Read

    Get Custom Field Values

    Get custom field values for a service. Scoped OAuth requires: `services.read`

    GET /services/{id}/custom_fields/values

  • Read

    Get Enablements for a Service

    List all feature enablement settings for a service. Currently, only the `aiops` enablement is supported. For any account with the AIOps product addon, every service will have AIOps features enabled by default. **Warning conditions**: - If the account is not entitled to use AIOps features, a warning will be returned alongside the enablement data. For PDRP customers, this feature is branded **Signal Intelligence** in the PagerDuty product UI. The API field names and values (e.g. `aiops`) are unchanged. Scoped OAuth requires: `services.read`

    GET /services/{id}/enablements

  • Write

    Create a service

    Create a new service. If `status` is included in the request, it must have a value of `active` when creating a new service. If a different status is required, make a second request to update the service. A service may represent an application, component, or team you wish to open incidents against. There is a limit of 25,000 services per account. If the limit is reached, the API will respond with an error. There is also a limit of 100,000 open Incidents per Service. If the limit is reached and `auto_resolve_timeout` is disabled (set to 0 or null), the `auto_resolve_timeout` property will automatically be set to 84600 (1 day). For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.write`

    POST /services

  • Write

    Create a new integration

    Create a new integration belonging to a Service. A service may represent an application, component, or team you wish to open incidents against. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.write`

    POST /services/{id}/integrations

  • Write

    Create an Event Rule on a Service

    Create a new Event Rule on a Service. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: `services.write`

    POST /services/{id}/rules

  • Write

    Convert a Service's Event Rules into Event Orchestration Rules

    Convert this Service's Event Rules into functionally equivalent Event Orchestration Rules. Sending a request to this API endpoint has several effects: 1. Automatically creates Event Orchestration Rules for this Service that will behave identically as this Service's currently configured Event Rules. 2. Makes all existing Event Rules for this Service read-only. All future updates need to be made via the newly created Event Orchestration rules. Sending a request to this API endpoint will **not** change how future events will be processed. If past events for this Service have been evaluated via Event Rules then new events sent to this Service will also continue to be evaluated via the (now read-only) Event Rules. To change this Service so that new events start being evaluated via the newly created Event Orchestration Rules use the [Update the Service Orchestration active status for a Service API](https://developer.pagerduty.com/api-reference/855659be83d9e-update-the-service-orchestration-active-status-for-a-service). > ### End-of-life > Event Rules will end-of-life soon. We highly recommend that you use this API to [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: `services.write`

    POST /services/{id}/rules/convert

  • Destructive

    Delete a service

    Delete an existing service. Once the service is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this service. A service may represent an application, component, or team you wish to open incidents against. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.write`

    DELETE /services/{id}

  • Destructive

    Update a service

    Update an existing service. A service may represent an application, component, or team you wish to open incidents against. There is a limit of 100,000 open Incidents per Service. If the limit is reached and you disable `auto_resolve_timeout` (set to 0 or null), the API will respond with an error. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.write`

    PUT /services/{id}

  • Destructive

    Update an existing integration

    Update an integration belonging to a Service. A service may represent an application, component, or team you wish to open incidents against. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#services) Scoped OAuth requires: `services.write`

    PUT /services/{id}/integrations/{integration_id}

  • Destructive

    Update an Event Rule on a Service

    Update an Event Rule on a Service. Note that the endpoint supports partial updates, so any number of the writable fields can be provided. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: `services.write`

    PUT /services/{id}/rules/{rule_id}

  • Destructive

    Delete an Event Rule from a Service

    Delete an Event Rule from a Service. <!-- theme: warning --> > ### End-of-life > Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting. Scoped OAuth requires: `services.write`

    DELETE /services/{id}/rules/{rule_id}

  • Destructive

    Update Custom Field Values

    Set custom field values for a service. Scoped OAuth requires: `services.write`

    PUT /services/{id}/custom_fields/values

  • Destructive

    Update an Enablement for a Service

    Update the feature enablement setting for a specific product addon on a service. This setting controls enabling or disabling the set of features contained within the addon. Currently, only `aiops` is supported as a valid feature enablement. **Warning conditions**: - If the account is not entitled to use AIOps features, the setting will be updated, but a warning will be returned. For PDRP customers, this feature is branded **Signal Intelligence** in the PagerDuty product UI. The API field names and values (e.g. `aiops`) are unchanged. Scoped OAuth requires: `services.write`

    PUT /services/{id}/enablements/{feature_name}

Service Custom Fields

  • Read

    List Fields

    List Custom Fields available for Services. Scoped OAuth requires: `custom_fields.read`

    GET /services/custom_fields

  • Read

    Get a Field

    Show detailed information about a Custom Field for Services. Scoped OAuth requires: `custom_fields.read`

    GET /services/custom_fields/{field_id}

  • Read

    List Field Options

    List all options for a given field. Scoped OAuth requires: `custom_fields.read`

    GET /services/custom_fields/{field_id}/field_options

  • Read

    Get a Field Option

    Get a field option for a given field. Scoped OAuth requires: `custom_fields.read`

    GET /services/custom_fields/{field_id}/field_options/{field_option_id}

  • Write

    Create a Field

    Creates a new Custom Field for Services, along with the Field Options if provided. Scoped OAuth requires: `custom_fields.write`

    POST /services/custom_fields

  • Write

    Create a Field Option

    Create a new option for the given field. Scoped OAuth requires: `custom_fields.write`

    POST /services/custom_fields/{field_id}/field_options

  • Destructive

    Update a Field

    Update a Custom Field for Services. Scoped OAuth requires: `custom_fields.write`

    PUT /services/custom_fields/{field_id}

  • Destructive

    Delete a Field

    Delete a Custom Field from Services. Scoped OAuth requires: `custom_fields.write`

    DELETE /services/custom_fields/{field_id}

  • Destructive

    Update a Field Option

    Update a field option for a given field. Scoped OAuth requires: `custom_fields.write`

    PUT /services/custom_fields/{field_id}/field_options/{field_option_id}

  • Destructive

    Delete a Field Option

    Delete a field option. Scoped OAuth requires: `custom_fields.write`

    DELETE /services/custom_fields/{field_id}/field_options/{field_option_id}

Session Configurations

  • Read

    Get an account's session configurations

    Retrieves session configurations for a PagerDuty account. Returns an array containing the requested configurations. If a specific type is requested, the array contains one item. If no type is specified, the array contains all available configurations (mobile and web). If no configurations exist, a 404 Not Found error will be returned. A Session Configuration needs to be created before it can be retrieved and used. Scoped OAuth requires: `session_configurations.read`

    GET /session_configurations

  • Destructive

    Configure an account's session configurations

    Creates or updates session configurations for a PagerDuty Account. The configurations will take effect immediately for new sessions, while existing sessions for the specified `types` are immediately revoked. Scoped OAuth requires: `session_configurations.write`

    PUT /session_configurations

  • Destructive

    Delete an account's session configurations.

    Deletes the session configurations for a PagerDuty account that was previously set. The type parameter is required and specifies which configurations to delete. A single type ('mobile' or 'web') or comma-separated list may be passed in. Scoped OAuth requires: `session_configurations.write`

    DELETE /session_configurations

Standards

  • Read

    List Standards

    Get all standards of an account. Scoped OAuth requires: `standards.read`

    GET /standards

  • Read

    List resources' standards scores

    List standards applied to a set of resources Scoped OAuth requires: `standards.read`

    GET /standards/scores/{resource_type}

  • Read

    List a resource's standards scores

    List standards applied to a specific resource Scoped OAuth requires: `standards.read`

    GET /standards/scores/{resource_type}/{id}

  • Destructive

    Update a standard

    Updates a standard Scoped OAuth requires: `standards.write`

    PUT /standards/{id}

Status Dashboards

  • Read

    List Status Dashboards

    Get all your account's custom Status Dashboard views. Scoped OAuth requires: `status_dashboards.read`

    GET /status_dashboards

  • Read

    Get a single Status Dashboard by `id`

    Get a Status Dashboard by its PagerDuty `id`. Scoped OAuth requires: `status_dashboards.read`

    GET /status_dashboards/{id}

  • Read

    Get impacted Business Services for a Status Dashboard by `id`.

    Get impacted Business Services for a Status Dashboard by `id` This endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted on the specified Status Dashboard up to the limit of 200. The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name. To get Impact information about a specific Business Service on the Status Dashboard that does not appear in the Impact-sorted response, use the `ids[]` parameter on the `/business_services/impacts` endpoint. Scoped OAuth requires: `status_dashboards.read`

    GET /status_dashboards/{id}/service_impacts

  • Read

    Get a single Status Dashboard by `url_slug`

    Get a Status Dashboard by its PagerDuty `url_slug`. A `url_slug` is a human-readable reference for a custom Status Dashboard that may be created or changed in the UI. It will generally be a `dash-separated-string-like-this`. Scoped OAuth requires: `status_dashboards.read`

    GET /status_dashboards/url_slugs/{url_slug}

  • Read

    Get impacted Business Services for a Status Dashboard by `url_slug`

    Get Business Service Impacts for the Business Services on a Status Dashboard by its `url_slug`. A `url_slug` is a human-readable reference for a custom Status Dashboard that may be created or changed in the UI. It will generally be a `dash-separated-string-like-this`. This endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted on the Status Dashboard up to the limit of 200. The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name. To get impact information about a specific Business Service on the Status Dashboard that does not appear in the Impact-sored response, use the `ids[]` parameter on the `/business_services/impacts` endpoint. Scoped OAuth requires: `status_dashboards.read`

    GET /status_dashboards/url_slugs/{url_slug}/service_impacts

Status Pages

  • Read

    List Status Pages

    List Status Pages. Scoped OAuth requires: `status_pages.read`

    GET /status_pages

  • Read

    List Status Page Impacts

    List Impacts for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.read`

    GET /status_pages/{id}/impacts

  • Read

    Get a Status Page Impact

    Get an Impact for a Status Page by Status Page ID and Impact ID. Scoped OAuth requires: `status_pages.read`

    GET /status_pages/{id}/impacts/{impact_id}

  • Read

    List Status Page Services

    List Services for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.read`

    GET /status_pages/{id}/services

  • Read

    Get a Status Page Service

    Get a Service for a Status Page by Status Page ID and Service ID. Scoped OAuth requires: `status_pages.read`

    GET /status_pages/{id}/services/{service_id}

  • Read

    List Status Page Severities

    List Severities for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.read`

    GET /status_pages/{id}/severities

  • Read

    Get a Status Page Severity

    Get a Severity for a Status Page by Status Page ID and Severity ID. Scoped OAuth requires: `status_pages.read`

    GET /status_pages/{id}/severities/{severity_id}

  • Read

    List Status Page Statuses

    List Statuses for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.read`

    GET /status_pages/{id}/statuses

  • Read

    Get a Status Page Status

    Get a Status for a Status Page by Status Page ID and Status ID. Scoped OAuth requires: `status_pages.read`

    GET /status_pages/{id}/statuses/{status_id}

  • Read

    List Status Page Posts

    List Posts for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.read`

    GET /status_pages/{id}/posts

  • Read

    Get a Status Page Post

    Get a Post for a Status Page by Status Page ID and Post ID. Scoped OAuth requires: `status_pages.read`

    GET /status_pages/{id}/posts/{post_id}

  • Read

    List Status Page Post Updates

    List Post Updates for a Status Page by Status Page ID and Post ID. Scoped OAuth requires: `status_pages.read`

    GET /status_pages/{id}/posts/{post_id}/post_updates

  • Read

    Get a Status Page Post Update

    Get a Post Update for a Post by Post ID and Post Update ID. Scoped OAuth requires: `status_pages.read`

    GET /status_pages/{id}/posts/{post_id}/post_updates/{post_update_id}

  • Read

    Get a Post Postmortem

    Get a Postmortem for a Post by Post ID. Scoped OAuth requires: `status_pages.read`

    GET /status_pages/{id}/posts/{post_id}/postmortem

  • Read

    List Status Page Subscriptions

    List Subscriptions for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.read`

    GET /status_pages/{id}/subscriptions

  • Read

    Get a Status Page Subscription

    Get a Subscription for a Status Page by Status Page ID and Subscription ID. Scoped OAuth requires: `status_pages.read`

    GET /status_pages/{id}/subscriptions/{subscription_id}

  • Write

    Create a Status Page Post

    Create a Post for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.write`

    POST /status_pages/{id}/posts

  • Write

    Create a Status Page Post Update

    Create a Post Update for a Post by Post ID. Scoped OAuth requires: `status_pages.write`

    POST /status_pages/{id}/posts/{post_id}/post_updates

  • Write

    Create a Status Page Subscription

    Create a Subscription for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.write`

    POST /status_pages/{id}/subscriptions

  • Destructive

    Update a Status Page Post

    Update a Post for a Status Page by Status Page ID. Scoped OAuth requires: `status_pages.write`

    PUT /status_pages/{id}/posts/{post_id}

  • Destructive

    Delete a Status Page Post

    Delete a Post for a Status Page by Status Page ID and Post ID. Scoped OAuth requires: `status_pages.write`

    DELETE /status_pages/{id}/posts/{post_id}

  • Destructive

    Update a Status Page Post Update

    Update a Post Update for a Post by Post ID and Post Update ID. Scoped OAuth requires: `status_pages.write`

    PUT /status_pages/{id}/posts/{post_id}/post_updates/{post_update_id}

  • Destructive

    Delete a Status Page Post Update

    Delete a Post Update for a Post by Post ID and Post Update ID. Scoped OAuth requires: `status_pages.write`

    DELETE /status_pages/{id}/posts/{post_id}/post_updates/{post_update_id}

  • Destructive

    Create or Update a Post Postmortem

    Create or Update a Postmortem for a Post by Post ID. Scoped OAuth requires: `status_pages.write`

    PUT /status_pages/{id}/posts/{post_id}/postmortem

  • Destructive

    Delete a Post Postmortem

    Delete a Postmortem for a Post by Post ID. Scoped OAuth requires: `status_pages.write`

    DELETE /status_pages/{id}/posts/{post_id}/postmortem

  • Destructive

    Delete a Status Page Subscription

    Delete a Subscription for a Status Page by Status Page ID and Subscription ID. Scoped OAuth requires: `status_pages.write`

    DELETE /status_pages/{id}/subscriptions/{subscription_id}

SRE Agent

  • Read

    List SRE Agent memories

    Search SRE Agent memories for the account. Memories are knowledge learned by the SRE Agent, including service runbooks, service profiles, incident playbooks, and incident summaries. Filter by service ID, incident ID, or memory type to retrieve relevant memories. Scoped OAuth requires: `incident.read`

    GET /sre_agent/memories

  • Destructive

    Update an SRE Agent memory

    Update an existing SRE Agent memory. Changes to the runbook may not update in a currently ongoing conversation, but will be available to new conversations. To modify the runbook for an in progress conversation update the runbook via the agent instead. Scoped OAuth requires: `sre_agent.write`

    PUT /sre_agent/memories/{id}

  • Destructive

    Delete an SRE Agent memory

    Permanently delete an SRE Agent memory. Deleting a runbook may not delete it immediately from a currently running conversation, but will remove it from all future conversations. To modify an in progress conversation ask the agent to delete the runbook instead. Scoped OAuth requires: `sre_agent.write`

    DELETE /sre_agent/memories/{id}

Teams

  • Read

    List teams

    List teams of your PagerDuty account, optionally filtered by a search query. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.read`

    GET /teams

  • Read

    Get a team

    Get details about an existing team. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.read`

    GET /teams/{id}

  • Read

    List audit records for a team

    The returned records are sorted by the `execution_time` from newest to oldest. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set. For more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/). Scoped OAuth requires: `audit_records.read`

    GET /teams/{id}/audit/records

  • Read

    List members of a team

    Get information about members on a team. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.read`

    GET /teams/{id}/members

  • Read

    List Team Notification Subscriptions

    Retrieve a list of Notification Subscriptions the given Team has. <!-- theme: warning --> > Teams must be added through `POST /teams/{id}/notification_subscriptions` to be returned from this endpoint. Scoped OAuth requires: `subscribers.read`

    GET /teams/{id}/notification_subscriptions

  • Write

    Create a team

    Create a new Team. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.write`

    POST /teams

  • Write

    Create Team Notification Subscriptions

    Create new Notification Subscriptions for the given Team. Scoped OAuth requires: `subscribers.write`

    POST /teams/{id}/notification_subscriptions

  • Destructive

    Delete a team

    Remove an existing team. Succeeds only if the team has no associated Escalation Policies, Services, Schedules and Subteams. All associated unresovled incidents will be reassigned to another team (if specified) or will loose team association, thus becoming account-level (with visibility implications). Note that the incidents reassignment process is asynchronous and has no guarantee to complete before the API call return. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.write`

    DELETE /teams/{id}

  • Destructive

    Update a team

    Update an existing team. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.write`

    PUT /teams/{id}

  • Destructive

    Remove an escalation policy from a team

    Remove an escalation policy from a team. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.write`

    DELETE /teams/{id}/escalation_policies/{escalation_policy_id}

  • Destructive

    Add an escalation policy to a team

    Add an escalation policy to a team. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.write`

    PUT /teams/{id}/escalation_policies/{escalation_policy_id}

  • Destructive

    Remove Team Notification Subscriptions

    Unsubscribe the given Team from Notifications on the matching Subscribable entities. Scoped OAuth requires: `subscribers.write`

    POST /teams/{id}/notification_subscriptions/unsubscribe

  • Destructive

    Remove a user from a team

    Remove a user from a team. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.write`

    DELETE /teams/{id}/users/{user_id}

  • Destructive

    Add a user to a team

    Add a user to a team. Attempting to add a user with the `read_only_user` role will return a 400 error. A team is a collection of Users and Escalation Policies that represent a group of people within an organization. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#teams) Scoped OAuth requires: `teams.write`

    PUT /teams/{id}/users/{user_id}

Templates

  • Read

    List templates

    Get a list of all the template on an account Scoped OAuth requires: `templates.read`

    GET /templates

  • Read

    Get a template

    Get a single template on the account Scoped OAuth requires: `templates.read`

    GET /templates/{id}

  • Read

    List template fields

    Get a list of fields that can be used on the account templates. Scoped OAuth requires: `templates.read`

    GET /templates/fields

  • Write

    Create a template

    Create a new template Scoped OAuth requires: `templates.write`

    POST /templates

  • Write

    Render a template

    Render a template. This endpoint has a variable request body depending on the template type. For the `status_update` template type, the caller will provide the incident id, and a status update message. Scoped OAuth requires: `templates.read`

    POST /templates/{id}/render

  • Destructive

    Update a template

    Update an existing template Scoped OAuth requires: `templates.write`

    PUT /templates/{id}

  • Destructive

    Delete a template

    Delete a specific of templates on the account Scoped OAuth requires: `templates.write`

    DELETE /templates/{id}

Users

  • Read

    List users

    List users of your PagerDuty account, optionally filtered by a search query. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.read`

    GET /users

  • Read

    Get a user

    Get details about an existing user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.read`

    GET /users/{id}

  • Read

    List audit records for a user

    The response will include audit records with changes that are made to the identified user not changes made by the identified user. The returned records are sorted by the `execution_time` from newest to oldest. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set. For more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/). Scoped OAuth requires: `audit_records.read`

    GET /users/{id}/audit/records

  • Read

    List a user's contact methods

    List contact methods of your PagerDuty user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.read`

    GET /users/{id}/contact_methods

  • Read

    Get a user's contact method

    Get details about a User's contact method. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.read`

    GET /users/{id}/contact_methods/{contact_method_id}

  • Read

    List a user's delegations

    Get a list of OAuth delegations for a specific user. This endpoint replaces the deprecated `/users/{id}/sessions` endpoint. **Required OAuth Scope:** For Scoped OAuth requests, this operation requires the `oauth_delegations.read` scope. Scoped OAuth requires: `oauth_delegations.read`

    GET /users/{id}/oauth_delegations

  • Read

    Get a user's delegation

    Get details about a specific OAuth delegation. This endpoint replaces the deprecated `/users/{id}/sessions/{session_id}` endpoint. **Required OAuth Scope:** For Scoped OAuth requests, this operation requires the `oauth_delegations.read` scope. Scoped OAuth requires: `oauth_delegations.read`

    GET /users/{id}/oauth_delegations/{delegation_id}

  • Read

    Get the License allocated to a User

    Get the License allocated to a User Scoped OAuth requires: `licenses.read`

    GET /users/{id}/license

  • Read

    List a user's notification rules

    List notification rules of your PagerDuty user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.read`

    GET /users/{id}/notification_rules

  • Read

    Get a user's notification rule

    Get details about a user's notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.read`

    GET /users/{id}/notification_rules/{notification_rule_id}

  • Read

    List Notification Subscriptions

    Retrieve a list of Notification Subscriptions the given User has. <!-- theme: warning --> > Users must be added through `POST /users/{id}/notification_subscriptions` to be returned from this endpoint. Scoped OAuth requires: `subscribers.read`

    GET /users/{id}/notification_subscriptions

  • Read

    List a User's Handoff Notification Rules

    List Handoff Notification Rules of your PagerDuty User. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.read`

    GET /users/{id}/oncall_handoff_notification_rules

  • Read

    Get a user's handoff notification rule

    Get details about a User's Handoff Notification Rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.read`

    GET /users/{id}/oncall_handoff_notification_rules/{oncall_handoff_notification_rule_id}

  • Read

    List a user's active sessions (deprecated)

    <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated, please use the [List OAuth Delegations endpoint](https://developer.pagerduty.com/api-reference/4f8e257df4468-list-a-user-s-delegations) instead. List active sessions of a PagerDuty user. Beginning November 2021, active sessions no longer includes newly issued OAuth tokens. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:sessions.read`

    GET /users/{id}/sessions

  • Read

    Get a user's session (deprecated)

    <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated, please use the [Get OAuth Delegation endpoint](https://developer.pagerduty.com/api-reference/3e32112cd7324-get-a-user-s-delegation) instead. Get details about a user's session. Beginning November 2021, user sessions no longer includes newly issued OAuth tokens. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:sessions.read`

    GET /users/{id}/sessions/{type}/{session_id}

  • Read

    List a user's status update notification rules

    List status update notification rules of your PagerDuty user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.read`

    GET /users/{id}/status_update_notification_rules

  • Read

    Get a user's status update notification rule

    Get details about a user's status update notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.read`

    GET /users/{id}/status_update_notification_rules/{status_update_notification_rule_id}

  • Read

    Get the current user

    Get details about the current user. This endpoint can only be used with a [user-level API key](https://support.pagerduty.com/docs/using-the-api#section-generating-a-personal-rest-api-key) or a key generated through an OAuth flow. This will not work if the request is made with an account-level access token. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users)

    GET /users/me

  • Write

    Create a user

    Create a new user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`

    POST /users

  • Write

    Create a user contact method

    Create a new contact method for the User. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.write`

    POST /users/{id}/contact_methods

  • Write

    Create a user notification rule

    Create a new notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.write`

    POST /users/{id}/notification_rules

  • Write

    Create Notification Subcriptions

    Create new Notification Subscriptions for the given User. Scoped OAuth requires: `subscribers.write`

    POST /users/{id}/notification_subscriptions

  • Write

    Create a User Handoff Notification Rule

    Create a new Handoff Notification Rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`

    POST /users/{id}/oncall_handoff_notification_rules

  • Write

    Create a user status update notification rule

    Create a new status update notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`

    POST /users/{id}/status_update_notification_rules

  • Write

    Regenerate a user's calendar feed URL key

    Regenerate the private URL key used to construct a user's personal iCal calendar feed URLs (`http_cal_url` and `web_cal_url`). The old key is immediately invalidated; callers should update any stored feed subscriptions with the new key. A user may only regenerate their own key. Account admins may regenerate on behalf of any user. The calendar feed URLs act as bearer credentials: anyone with the URL can read that user's on-call calendar without further authentication. Rotate the key here whenever a URL may have been exposed (for example, if it was shared outside the intended audience or if an admin with `can_update_user` retrieved it via `GET /users/{id}?include[]=calendar_urls`). Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`

    POST /users/{id}/regenerate_private_url_key

  • Destructive

    Delete a user

    Remove an existing user. Returns 400 if the user has assigned incidents unless your [pricing plan](https://www.pagerduty.com/pricing) has the `offboarding` feature and the account is [configured](https://support.pagerduty.com/docs/offboarding#section-additional-configurations) appropriately. Note that the incidents reassignment process is asynchronous and has no guarantee to complete before the api call return. [*Learn more about `offboarding` feature*](https://support.pagerduty.com/docs/offboarding). Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`

    DELETE /users/{id}

  • Destructive

    Update a user

    Update an existing user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`

    PUT /users/{id}

  • Destructive

    Delete a user's contact method

    Remove a user's contact method. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.write`

    DELETE /users/{id}/contact_methods/{contact_method_id}

  • Destructive

    Update a user's contact method

    Update a User's contact method. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.write`

    PUT /users/{id}/contact_methods/{contact_method_id}

  • Destructive

    Delete a user's notification rule

    Remove a user's notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.write`

    DELETE /users/{id}/notification_rules/{notification_rule_id}

  • Destructive

    Update a user's notification rule

    Update a user's notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:contact_methods.write`

    PUT /users/{id}/notification_rules/{notification_rule_id}

  • Destructive

    Remove Notification Subscriptions

    Unsubscribe the given User from Notifications on the matching Subscribable entities. Scoped OAuth requires: `subscribers.write`

    POST /users/{id}/notification_subscriptions/unsubscribe

  • Destructive

    Delete a User's Handoff Notification rule

    Remove a User's Handoff Notification Rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`

    DELETE /users/{id}/oncall_handoff_notification_rules/{oncall_handoff_notification_rule_id}

  • Destructive

    Update a User's Handoff Notification Rule

    Update a User's Handoff Notification Rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`

    PUT /users/{id}/oncall_handoff_notification_rules/{oncall_handoff_notification_rule_id}

  • Destructive

    Delete all user sessions (deprecated)

    <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated as OAuth token revocation is now synchronous. Please use the [DELETE /oauth_delegations endpoint](https://developer.pagerduty.com/api-reference/ad1161db75db1-delete-all-o-auth-delegations) instead. Delete all user sessions. Beginning November 2021, user sessions no longer includes newly issued OAuth tokens. If you are interested in deleting mobile app sessions, refer to the Delete OAuth Delegations endpoint. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:sessions.write`

    DELETE /users/{id}/sessions

  • Destructive

    Delete a user's session (deprecated)

    <!-- theme: warning --> > ### Deprecated > This endpoint is deprecated as OAuth token revocation is now synchronous. Please use the [DELETE /oauth_delegations endpoint](https://developer.pagerduty.com/api-reference/ad1161db75db1-delete-all-o-auth-delegations) instead. Delete a user's session. Beginning November 2021, user sessions no longer includes newly issued OAuth tokens. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users:sessions.write`

    DELETE /users/{id}/sessions/{type}/{session_id}

  • Destructive

    Delete a user's status update notification rule

    Remove a user's status update notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`

    DELETE /users/{id}/status_update_notification_rules/{status_update_notification_rule_id}

  • Destructive

    Update a user's status update notification rule

    Update a user's status update notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#users) Scoped OAuth requires: `users.write`

    PUT /users/{id}/status_update_notification_rules/{status_update_notification_rule_id}

Vendors

  • Read

    List vendors

    List all vendors. A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#vendors) Scoped OAuth requires: `vendors.read`

    GET /vendors

  • Read

    Get a vendor

    Get details about one specific vendor. A PagerDuty Vendor represents a specific type of integration. AWS Cloudwatch, Splunk, Datadog are all examples of vendors For more information see the [API Concepts Document](../../api-reference/a47605517c19a-api-concepts#vendors) Scoped OAuth requires: `vendors.read`

    GET /vendors/{id}

Schedules v3

  • Read

    List schedules

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve a paginated list of schedule references. Returns lightweight objects without embedded rotations or events. Each result is filtered by the caller's read permission; schedules the caller cannot read are silently excluded.

    GET /v3/schedules

  • Read

    Get a schedule

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve a schedule by ID including rotations and events. Optionally include the computed final schedule for a time range. Use `include[]=final_schedule` to get computed on-call assignments. Use `since` and `until` to specify the time range.

    GET /v3/schedules/{id}

  • Read

    List audit records for a schedule

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). The returned records are sorted by the `execution_time` from newest to oldest. See [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set. For more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/). Scoped OAuth requires: `audit_records.read`

    GET /v3/schedules/{id}/audit/records

  • Read

    List custom shifts

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve custom shifts for a schedule within a time range. **`since` and `until` are required.** Returns every custom shift that overlaps the window.

    GET /v3/schedules/{id}/custom_shifts

  • Read

    Get a custom shift

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve a single custom shift by ID.

    GET /v3/schedules/{id}/custom_shifts/{custom_shift_id}

  • Read

    List overrides

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve overrides for a schedule within a time range. **`since` and `until` are required.** Returns every override that overlaps the window.

    GET /v3/schedules/{id}/overrides

  • Read

    Get an override

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve a single override by ID.

    GET /v3/schedules/{id}/overrides/{override_id}

  • Read

    List rotations

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve all rotations for a schedule.

    GET /v3/schedules/{id}/rotations

  • Read

    Get a rotation

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve a rotation by ID including all its events.

    GET /v3/schedules/{id}/rotations/{rotation_id}

  • Read

    List events

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve all events for a rotation, ordered by start time.

    GET /v3/schedules/{id}/rotations/{rotation_id}/events

  • Read

    Get an event

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Retrieve a specific event by ID.

    GET /v3/schedules/{id}/rotations/{rotation_id}/events/{event_id}

  • Write

    Create a schedule

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Create a new on-call schedule with basic metadata. Rotations and events must be added via separate API calls after creation. **Rejected fields:** `rotations` and `escalation_policies` are not accepted in the request body and will result in a 400 error.

    POST /v3/schedules

  • Write

    Create custom shifts

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Create one or more custom shifts for a schedule. Custom shifts are ad-hoc one-off coverage periods that exist outside of rotation events. Each custom shift requires exactly one assignment.

    POST /v3/schedules/{id}/custom_shifts

  • Write

    Create overrides

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Create one or more overrides for a schedule. An override temporarily replaces a scheduled on-call member with a different member for a specific time period. Each override must reference either a `rotation_id` or a `custom_shift_id` (not both). The overriding member must belong to the account. **Note:** The create response wraps the result in an `overrides` array. Single-resource endpoints (get, update) wrap in `override` (singular).

    POST /v3/schedules/{id}/overrides

  • Write

    Create a rotation

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Create a new empty rotation for a schedule. After creating a rotation, add events to define the on-call pattern. **Note:** Rotations have no configuration of their own — all scheduling logic (recurrence, assignment strategy, members) is specified on events. The request body must be empty or `{}`.

    POST /v3/schedules/{id}/rotations

  • Write

    Create an event

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Create a new event that defines when and how users are on-call within a rotation. **Constraints:** - Maximum 5 events per rotation - Events within a rotation cannot overlap - `effective_since` must be in the future (past values are clamped to now) - All users referenced in `assignment_strategy.members` must exist and belong to the account

    POST /v3/schedules/{id}/rotations/{rotation_id}/events

  • Destructive

    Update a schedule

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Update schedule metadata (name, description, time zone). `time_zone` is required; `name` and `description` are optional and keep their current values when omitted. To modify rotations or events, use their respective endpoints. **Rejected fields:** `rotations` and `escalation_policies` are not accepted and will result in a 400 error.

    PUT /v3/schedules/{id}

  • Destructive

    Delete a schedule

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Delete a schedule and all associated rotations and events. If the schedule is referenced by an active escalation policy, the deletion will be rejected.

    DELETE /v3/schedules/{id}

  • Destructive

    Update a custom shift

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Update an existing custom shift. If the shift has already started, only `end_time` can be modified.

    PUT /v3/schedules/{id}/custom_shifts/{custom_shift_id}

  • Destructive

    Delete a custom shift

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Delete a custom shift by ID. When the shift is not started, it deletes the shift entirely. If the shift is already started, it sets the end_time to now. It returns Bad Request when shift is already ended.

    DELETE /v3/schedules/{id}/custom_shifts/{custom_shift_id}

  • Destructive

    Update an override

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Update an existing override. Once the override has started, only `end_time` can be changed.

    PUT /v3/schedules/{id}/overrides/{override_id}

  • Destructive

    Delete an override

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Delete an override by ID.

    DELETE /v3/schedules/{id}/overrides/{override_id}

  • Destructive

    Delete a rotation

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Delete a rotation and all its events. On deletion, past events are preserved in the audit history, the current active event is truncated to the deletion time, and future events are removed.

    DELETE /v3/schedules/{id}/rotations/{rotation_id}

  • Destructive

    Update an event

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Update an existing event. **Restrictions based on event timing:** - **Past events** (effective_until in the past): Cannot be modified - **Active events** (currently producing shifts): Can only update `effective_until` - **Future events** (effective_since in the future): All fields can be updated

    PUT /v3/schedules/{id}/rotations/{rotation_id}/events/{event_id}

  • Destructive

    Delete an event

    <!-- theme: info --> > **Important note:** Shift-based schedules use the V3 API and are not compatible with V2 automations. **To create automations for Shift-Based Schedules, you need to:** > > 1. **Update your automations** to use the V3 API for all new shift-based schedules > 2. **Keep the V2 endpoint** for your existing schedules > > An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https://support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples). Delete an event from a rotation.

    DELETE /v3/schedules/{id}/rotations/{rotation_id}/events/{event_id}

Webhooks

  • Read

    List webhook subscriptions

    List existing webhook subscriptions. The `filter_type` and `filter_id` query parameters may be used to only show subscriptions for a particular _service_ or _team_. For more information on webhook subscriptions and how they are used to configure v3 webhooks see the [Webhooks v3 Developer Documentation](https://developer.pagerduty.com/docs/webhooks/v3-overview/). Scoped OAuth requires: `webhook_subscriptions.read`

    GET /webhook_subscriptions

  • Read

    Get a webhook subscription

    Gets details about an existing webhook subscription. Scoped OAuth requires: `webhook_subscriptions.read`

    GET /webhook_subscriptions/{id}

  • Read

    List OAuth clients

    List all OAuth clients for webhook subscriptions. Maximum of 10 clients per account. Requires admin or owner role permissions.

    GET /webhook_subscriptions/oauth_clients

  • Read

    Get an OAuth client

    Get details of a specific OAuth client by ID. Requires admin or owner role permissions.

    GET /webhook_subscriptions/oauth_clients/{id}

  • Write

    Create a webhook subscription

    Creates a new webhook subscription. For more information on webhook subscriptions and how they are used to configure v3 webhooks see the [Webhooks v3 Developer Documentation](https://developer.pagerduty.com/docs/webhooks/v3-overview/). Scoped OAuth requires: `webhook_subscriptions.write`

    POST /webhook_subscriptions

  • Write

    Enable a webhook subscription

    Enable a webhook subscription that is temporarily disabled. (This API does not require a request body.) Webhook subscriptions can become temporarily disabled when the subscription's delivery method is repeatedly rejected by the server. Scoped OAuth requires: `webhook_subscriptions.write`

    POST /webhook_subscriptions/{id}/enable

  • Write

    Test a webhook subscription

    Test a webhook subscription. Fires a test event against the webhook subscription. If properly configured, this will deliver the `pagey.ping` webhook event to the destination. Scoped OAuth requires: `webhook_subscriptions.write`

    POST /webhook_subscriptions/{id}/ping

  • Write

    Create an OAuth client

    Create a new OAuth client for webhook subscriptions. The client credentials will be validated by attempting to obtain an access token before creation. Requires admin or owner role permissions. Maximum of 10 OAuth clients per account.

    POST /webhook_subscriptions/oauth_clients

  • Destructive

    Update a webhook subscription

    Updates an existing webhook subscription. Only the fields being updated need to be included on the request. This operation does not support updating the `delivery_method` of the webhook subscription. Scoped OAuth requires: `webhook_subscriptions.write`

    PUT /webhook_subscriptions/{id}

  • Destructive

    Delete a webhook subscription

    Deletes a webhook subscription. Scoped OAuth requires: `webhook_subscriptions.write`

    DELETE /webhook_subscriptions/{id}

  • Destructive

    Update an OAuth client

    Update an existing OAuth client. Any change will trigger token validation with the OAuth server. Requires admin or owner role permissions.

    PUT /webhook_subscriptions/oauth_clients/{id}

  • Destructive

    Delete an OAuth client

    Delete an OAuth client. This will also remove the OAuth client association from any webhook subscriptions using it. Requires admin or owner role permissions.

    DELETE /webhook_subscriptions/oauth_clients/{id}

Workflow Integrations

  • Read

    List Workflow Integrations

    List available Workflow Integrations. Scoped OAuth requires: `workflow_integrations.read`

    GET /workflows/integrations

  • Read

    Get Workflow Integration

    Get details about a Workflow Integration. Scoped OAuth requires: `workflow_integrations.read`

    GET /workflows/integrations/{id}

  • Read

    List all Workflow Integration Connections

    List all Workflow Integration Connections. Scoped OAuth requires: `workflow_integrations:connections.read`

    GET /workflows/integrations/connections

  • Read

    List Workflow Integration Connections

    List all Workflow Integration Connections for a specific Workflow Integration. Scoped OAuth requires: `workflow_integrations:connections.read`

    GET /workflows/integrations/{integration_id}/connections

  • Read

    Get Workflow Integration Connection

    Get details about a Workflow Integration Connection. Scoped OAuth requires: `workflow_integrations:connections.read`

    GET /workflows/integrations/{integration_id}/connections/{id}

  • Write

    Create Workflow Integration Connection

    Create a new Workflow Integration Connection. Scoped OAuth requires: `workflow_integrations:connections.write`

    POST /workflows/integrations/{integration_id}/connections

  • Write

    Update Workflow Integration Connection

    Update an existing Workflow Integration Connection. Scoped OAuth requires: `workflow_integrations:connections.write`

    PATCH /workflows/integrations/{integration_id}/connections/{id}

  • Destructive

    Delete Workflow Integration Connection

    Delete a Workflow Integration Connection. Scoped OAuth requires: `workflow_integrations:connections.write`

    DELETE /workflows/integrations/{integration_id}/connections/{id}

Recommendations

  • Read

    List recommended rules

    List AI-generated recommended rules available for an account's Service Event Orchestrations. Results can be filtered by service or team. Use cursor-based pagination to retrieve large result sets. Note: `service_id` and `service_ids[]` cannot be used together in the same request. Scoped OAuth requires: `recommendations.read`

    GET /recommendations/event_orchestrations/rules

  • Write

    Dismiss a recommended rule

    Dismiss a recommended rule for a service, recording feedback on whether the recommendation was useful. Scoped OAuth requires: `recommendations.write`

    POST /recommendations/event_orchestrations/services/{service_id}/rules/{recommendation_id}/dismiss

  • Write

    Accept a recommended rule

    Accept a recommended rule and apply it to the service's Event Orchestration. Scoped OAuth requires: `recommendations.write`

    POST /recommendations/event_orchestrations/services/{service_id}/rules/{recommendation_id}/accept

  • Destructive

    Delete an accepted rule

    Remove a previously accepted recommended rule from a service's Event Orchestration. Scoped OAuth requires: `recommendations.write`

    DELETE /recommendations/event_orchestrations/services/{service_id}/accepted_rules/{rule_id}

Send Change Event

  • Write

    Send change events to the PagerDuty Events API

    Change Events API enables you to send informational events about recent changes such as code deploys and system config changes from any system that can make an outbound HTTP connection. These events do not create incidents and do not send notifications; they are shown in context with incidents on the same PagerDuty service.

    POST /change/enqueue

Send Event

  • Destructive

    Send an event to PagerDuty

    Your monitoring tools should send PagerDuty a trigger event to report a new problem, or update an ongoing problem, depending on the event type.

    POST /enqueue

See How connections work for access and permissions, or browse all integrations.